diff options
| author | Dax Raad <[email protected]> | 2025-05-31 14:41:00 -0400 |
|---|---|---|
| committer | Dax Raad <[email protected]> | 2025-05-31 14:41:00 -0400 |
| commit | 3b746162d27a32a851aa257455042b5a86ec017c (patch) | |
| tree | 94f7d24c39735d28f0fa17f726b02c2cfbc6266a /packages/web/src/content/docs | |
| parent | 6df19f1828a0b98d476b2d0929aea67f61832717 (diff) | |
| download | opencode-3b746162d27a32a851aa257455042b5a86ec017c.tar.gz opencode-3b746162d27a32a851aa257455042b5a86ec017c.zip | |
run formatter
Diffstat (limited to 'packages/web/src/content/docs')
| -rw-r--r-- | packages/web/src/content/docs/docs/cli.mdx | 22 | ||||
| -rw-r--r-- | packages/web/src/content/docs/docs/config.mdx | 23 | ||||
| -rw-r--r-- | packages/web/src/content/docs/docs/themes.mdx | 14 |
3 files changed, 29 insertions, 30 deletions
diff --git a/packages/web/src/content/docs/docs/cli.mdx b/packages/web/src/content/docs/docs/cli.mdx index 44a56e1fb..af1016152 100644 --- a/packages/web/src/content/docs/docs/cli.mdx +++ b/packages/web/src/content/docs/docs/cli.mdx @@ -20,21 +20,21 @@ Or start with a specific working directory. opencode -c /path/to/project ``` -## Flags +## Flags The OpenCode CLI takes the following flags. -| Flag | Short | Description | -| -- | -- | -- | -| `--help` | `-h` | Display help | -| `--debug` | `-d` | Enable debug mode | -| `--cwd` | `-c` | Set current working directory | -| `--prompt` | `-p` | Run a single prompt in non-interactive mode | +| Flag | Short | Description | +| ----------------- | ----- | -------------------------------------------------------- | +| `--help` | `-h` | Display help | +| `--debug` | `-d` | Enable debug mode | +| `--cwd` | `-c` | Set current working directory | +| `--prompt` | `-p` | Run a single prompt in non-interactive mode | | `--output-format` | `-f` | Output format for non-interactive mode, `text` or `json` | -| `--quiet` | `-q` | Hide spinner in non-interactive mode | -| `--verbose` | | Display logs to stderr in non-interactive mode | -| `--allowedTools` | | Restrict the agent to only use specified tools | -| `--excludedTools` | | Prevent the agent from using specified tools | +| `--quiet` | `-q` | Hide spinner in non-interactive mode | +| `--verbose` | | Display logs to stderr in non-interactive mode | +| `--allowedTools` | | Restrict the agent to only use specified tools | +| `--excludedTools` | | Prevent the agent from using specified tools | ## Non-interactive diff --git a/packages/web/src/content/docs/docs/config.mdx b/packages/web/src/content/docs/docs/config.mdx index 288f194c5..9617612d0 100644 --- a/packages/web/src/content/docs/docs/config.mdx +++ b/packages/web/src/content/docs/docs/config.mdx @@ -73,16 +73,15 @@ The config file has the following structure. For the providers, you can also specify the keys using environment variables. -| Environment Variable | Models | -| -------------------------- | ----------- | -| `ANTHROPIC_API_KEY` | Claude | -| `OPENAI_API_KEY` | OpenAI | -| `GEMINI_API_KEY` | Google Gemini | -| `GROQ_API_KEY` | Groq | -| `AWS_ACCESS_KEY_ID` | Amazon Bedrock | -| `AWS_SECRET_ACCESS_KEY` | Amazon Bedrock | -| `AWS_REGION` | Amazon Bedrock | -| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI | +| Environment Variable | Models | +| -------------------------- | ------------------------------------------ | +| `ANTHROPIC_API_KEY` | Claude | +| `OPENAI_API_KEY` | OpenAI | +| `GEMINI_API_KEY` | Google Gemini | +| `GROQ_API_KEY` | Groq | +| `AWS_ACCESS_KEY_ID` | Amazon Bedrock | +| `AWS_SECRET_ACCESS_KEY` | Amazon Bedrock | +| `AWS_REGION` | Amazon Bedrock | +| `AZURE_OPENAI_ENDPOINT` | Azure OpenAI | | `AZURE_OPENAI_API_KEY` | Azure OpenAI, optional when using Entra ID | -| `AZURE_OPENAI_API_VERSION` | Azure OpenAI | - +| `AZURE_OPENAI_API_VERSION` | Azure OpenAI | diff --git a/packages/web/src/content/docs/docs/themes.mdx b/packages/web/src/content/docs/docs/themes.mdx index e691a22e7..a177ea3bc 100644 --- a/packages/web/src/content/docs/docs/themes.mdx +++ b/packages/web/src/content/docs/docs/themes.mdx @@ -55,14 +55,14 @@ You can create your own custom theme by setting the `theme: custom` and providin You can define any of the following color keys in your `customTheme`. -| Type | Color keys | -| --- | --- | -| Base colors | `primary`, `secondary`, `accent` | -| Status colors | `error`, `warning`, `success`, `info` | -| Text colors | `text`, `textMuted`, `textEmphasized` | +| Type | Color keys | +| ----------------- | ------------------------------------------------------- | +| Base colors | `primary`, `secondary`, `accent` | +| Status colors | `error`, `warning`, `success`, `info` | +| Text colors | `text`, `textMuted`, `textEmphasized` | | Background colors | `background`, `backgroundSecondary`, `backgroundDarker` | -| Border colors | `borderNormal`, `borderFocused`, `borderDim` | -| Diff view colors | `diffAdded`, `diffRemoved`, `diffContext`, etc. | +| Border colors | `borderNormal`, `borderFocused`, `borderDim` | +| Diff view colors | `diffAdded`, `diffRemoved`, `diffContext`, etc. | You don't need to define all the color keys. Any undefined colors will fall back to the default `opencode` theme colors. |
