diff options
| author | Aiden Cline <[email protected]> | 2025-12-12 16:47:50 -0600 |
|---|---|---|
| committer | Aiden Cline <[email protected]> | 2025-12-12 16:47:50 -0600 |
| commit | b93614cb81c1a84c4ad4ccd68d6858f6cf6d21e1 (patch) | |
| tree | 2e66f5de878edaed5ca9f10485d841d0d435d1cc /packages | |
| parent | b84d513bd7e8c2e38e7a2e6ea1315a224e4b6429 (diff) | |
| download | opencode-b93614cb81c1a84c4ad4ccd68d6858f6cf6d21e1.tar.gz opencode-b93614cb81c1a84c4ad4ccd68d6858f6cf6d21e1.zip | |
docs: add env vars sections
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/opencode/src/flag/flag.ts | 1 | ||||
| -rw-r--r-- | packages/web/src/content/docs/cli.mdx | 37 |
2 files changed, 37 insertions, 1 deletions
diff --git a/packages/opencode/src/flag/flag.ts b/packages/opencode/src/flag/flag.ts index c4a03e831..ca1af6d84 100644 --- a/packages/opencode/src/flag/flag.ts +++ b/packages/opencode/src/flag/flag.ts @@ -18,7 +18,6 @@ export namespace Flag { export const OPENCODE_EXPERIMENTAL = truthy("OPENCODE_EXPERIMENTAL") export const OPENCODE_EXPERIMENTAL_ICON_DISCOVERY = OPENCODE_EXPERIMENTAL || truthy("OPENCODE_EXPERIMENTAL_ICON_DISCOVERY") - export const OPENCODE_EXPERIMENTAL_WATCHER = OPENCODE_EXPERIMENTAL || truthy("OPENCODE_EXPERIMENTAL_WATCHER") export const OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT = truthy("OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT") export const OPENCODE_ENABLE_EXA = truthy("OPENCODE_ENABLE_EXA") || OPENCODE_EXPERIMENTAL || truthy("OPENCODE_EXPERIMENTAL_EXA") diff --git a/packages/web/src/content/docs/cli.mdx b/packages/web/src/content/docs/cli.mdx index 083db369b..64e11ff56 100644 --- a/packages/web/src/content/docs/cli.mdx +++ b/packages/web/src/content/docs/cli.mdx @@ -269,3 +269,40 @@ The opencode CLI takes the following global flags. | `--version` | `-v` | Print version number | | `--print-logs` | | Print logs to stderr | | `--log-level` | | Log level (DEBUG, INFO, WARN, ERROR) | + +--- + +## Environment variables + +OpenCode can be configured using environment variables. + +| Variable | Type | Description | +| ------------------------------------- | ------- | -------------------------------------- | +| `OPENCODE_AUTO_SHARE` | boolean | Automatically share sessions | +| `OPENCODE_GIT_BASH_PATH` | string | Path to Git Bash executable on Windows | +| `OPENCODE_CONFIG` | string | Path to config file | +| `OPENCODE_CONFIG_DIR` | string | Path to config directory | +| `OPENCODE_CONFIG_CONTENT` | string | Inline json config content | +| `OPENCODE_DISABLE_AUTOUPDATE` | boolean | Disable automatic update checks | +| `OPENCODE_DISABLE_PRUNE` | boolean | Disable pruning of old data | +| `OPENCODE_PERMISSION` | string | Inlined json permissions config | +| `OPENCODE_DISABLE_DEFAULT_PLUGINS` | boolean | Disable default plugins | +| `OPENCODE_DISABLE_LSP_DOWNLOAD` | boolean | Disable automatic LSP server downloads | +| `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | boolean | Enable experimental models | +| `OPENCODE_DISABLE_AUTOCOMPACT` | boolean | Disable automatic context compaction | +| `OPENCODE_CLIENT` | string | Client identifier (defaults to `cli`) | +| `OPENCODE_ENABLE_EXA` | boolean | Enable Exa web search tools | + +--- + +### Experimental + +These environment variables enable experimental features that may change or be removed. + +| Variable | Type | Description | +| ----------------------------------------------- | ------- | --------------------------------------- | +| `OPENCODE_EXPERIMENTAL` | boolean | Enable all experimental features | +| `OPENCODE_EXPERIMENTAL_ICON_DISCOVERY` | boolean | Enable icon discovery | +| `OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT` | boolean | Disable copy on select in TUI | +| `OPENCODE_EXPERIMENTAL_BASH_MAX_OUTPUT_LENGTH` | number | Max output length for bash commands | +| `OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS` | number | Default timeout for bash commands in ms | |