Skip to content

Commit 231a1ae

Browse files
committed
docs: Improve structure of local file syncing section
1 parent 302b4f3 commit 231a1ae

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -187,9 +187,11 @@ for chunk in response:
187187
yield chunk
188188
```
189189

190-
## File Synchronization
190+
## Local File Development
191191

192-
Humanloop allows you to clone files from your Humanloop workspace to your local filesystem using the CLI.
192+
Humanloop allows you to clone files from your Humanloop workspace to your local filesystem and use them in your code.
193+
194+
### Syncing Files with the CLI
193195

194196
```bash
195197
# Pull all files
@@ -205,6 +207,8 @@ humanloop pull --path="examples/chat/basic.prompt"
205207
humanloop pull --environment="production"
206208
```
207209

210+
### Using Local Files in the SDK
211+
208212
To use local files in your code:
209213

210214
```python
@@ -216,14 +220,14 @@ client = Humanloop(
216220

217221
# Use a local prompt file
218222
response = client.prompts.call(
219-
path="examples/chat/basic", # No file extension needed
223+
path="examples/chat/basic",
220224
inputs={"query": "Hello world"}
221225
)
222226
```
223227

224-
For detailed instructions on syncing, see our [Guide to Syncing and Using Local Files](https://humanloop.com/docs/v5/guides/prompts/syncing-local-files).
228+
For detailed instructions on syncing, see our [Guide to Syncing and Using Local Files](https://humanloop.com/docs/v5/guides/prompts/syncing-files).
225229

226-
For information about the `.prompt` and `.agent` file formats, see our [File Format Reference](https://humanloop.com/docs/v5/reference/prompt-and-agent-files).
230+
For information about the `.prompt` and `.agent` file formats, see our [File Format Reference](https://humanloop.com/docs/v5/reference/prompt-and-agent-files).
227231

228232
## Pagination
229233

@@ -291,6 +295,7 @@ client.prompts.log(..., request_options={
291295

292296
You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
293297
and transports.
298+
294299
```python
295300
import httpx
296301
from humanloop import Humanloop

0 commit comments

Comments
 (0)