Skip to content

Commit

Permalink
Add new env vars catalog page under Tools
Browse files Browse the repository at this point in the history
  • Loading branch information
J2-D2-3PO committed Nov 20, 2024
1 parent 7aa0140 commit 5586094
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
39 changes: 39 additions & 0 deletions docs/docs/guides/tools/env-vars.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Environment variables

Weave provides a set of environment variables to configure and optimize its behavior. You can set these variables in your shell or within scripts to control specific functionality.

```bash
# Example of setting environment variables in the shell
WEAVE_PARALLELISM=10 # Controls the number of parallel workers
WEAVE_PRINT_CALL_LINK=false # Disables call link output
```

```python
# Example of setting environment variables in Python
import os

os.environ["WEAVE_PARALLELISM"] = "10"
os.environ["WEAVE_PRINT_CALL_LINK"] = "false"
```

## Environment variables reference

Here’s a complete list of available environment variables for Weave, along with their usage:

| Variable name | Usage | Default |
| --------------------------- | ---------- | ------------ |
| **WEAVE_PARALLELISM** | Sets the number of parallel workers for Weave operations. | 20 |
| **WEAVE_PRINT_CALL_LINK** | Controls whether call link output is displayed. Set to `true` or `false`. | `true` |
| **WEAVE_SENTRY_ENV** | | |
| **WEAVE_SERVER_DISABLE_ECOSYSTEM** | | |
| **WEAVE_TRACE_LANGCHAIN** | | |
| **WEAVE_PROJECT** | | |
| **WEAVE_DISABLED** | | |
| **WEAVE_CAPTURE_CODE** | | |
| **WEAVE_SKIP_BUILD** | | |
| **WEAVE_CACHE_CLEAR_INTERVAL** | | |
| **WEAVE_OP_PATTERN** | | |
| **WEAVE_SLUG** | | |
| **WEAVE_DEBUG_HTTP** | | |


2 changes: 1 addition & 1 deletion docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ const sidebars: SidebarsConfig = {
collapsed: true,
label: "Tools & Utilities",
link: { type: "doc", id: "guides/tools/index" },
items: ["guides/tools/serve", "guides/tools/deploy"],
items: ["guides/tools/serve", "guides/tools/deploy", "guides/tools/env-vars"],
},
],
},
Expand Down

0 comments on commit 5586094

Please sign in to comment.