Skip to content

Commit a6964d8

Browse files
committed
docs: improve help for pull command in cli
1 parent 861e45f commit a6964d8

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

src/humanloop/cli/__main__.py

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -147,25 +147,29 @@ def pull(
147147
148148
\b
149149
This command will:
150-
1. Fetch prompt and agent files from your Humanloop workspace
150+
1. Fetch Prompt and Agent files from your Humanloop workspace
151151
2. Save them to your local filesystem
152152
3. Maintain the same directory structure as in Humanloop
153153
4. Add appropriate file extensions (.prompt or .agent)
154154
155155
\b
156156
The files will be saved with the following structure:
157157
{base_dir}/
158-
├── prompts/
159-
│ ├── my_prompt.prompt
160-
│ └── nested/
161-
│ └── another_prompt.prompt
162-
└── agents/
163-
└── my_agent.agent
164-
165-
The operation will overwrite existing files with the latest version from Humanloop
166-
but will not delete local files that don't exist in the remote workspace.
167-
168-
Currently only supports syncing prompt and agent files. Other file types will be skipped."""
158+
├── my_project/
159+
│ ├── prompts/
160+
│ │ ├── my_prompt.prompt
161+
│ │ └── nested/
162+
│ │ └── another_prompt.prompt
163+
│ └── agents/
164+
│ └── my_agent.agent
165+
└── another_project/
166+
└── prompts/
167+
└── other_prompt.prompt
168+
169+
If a file exists both locally and in the Humanloop workspace, the local file will be overwritten
170+
with the version from Humanloop. Files that only exist locally will not be affected.
171+
172+
Currently only supports syncing Prompt and Agent files. Other file types will be skipped."""
169173
client = get_client(api_key, env_file, base_url)
170174
sync_client = SyncClient(client, base_dir=base_dir, log_level=logging.DEBUG if verbose else logging.WARNING)
171175

0 commit comments

Comments
 (0)