diff options
| author | Haris Gušić <[email protected]> | 2025-10-31 22:59:59 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-10-31 16:59:59 -0500 |
| commit | a5ede68241bc971d7fdeea799e506928e1aa411e (patch) | |
| tree | 4e0b0279c63a6ad2b31960bec936b9713b26e615 /packages/web/src/content/docs/cli.mdx | |
| parent | 60dc38050dfd9c39428ec366d4a40b8fd47674f9 (diff) | |
| download | opencode-a5ede68241bc971d7fdeea799e506928e1aa411e.tar.gz opencode-a5ede68241bc971d7fdeea799e506928e1aa411e.zip | |
fix: Remove conflicting "-h" aliases in TUI spawn and thread commands (#3651)
Diffstat (limited to 'packages/web/src/content/docs/cli.mdx')
| -rw-r--r-- | packages/web/src/content/docs/cli.mdx | 61 |
1 files changed, 41 insertions, 20 deletions
diff --git a/packages/web/src/content/docs/cli.mdx b/packages/web/src/content/docs/cli.mdx index 2fd3a0f5c..1312442d6 100644 --- a/packages/web/src/content/docs/cli.mdx +++ b/packages/web/src/content/docs/cli.mdx @@ -19,6 +19,28 @@ opencode run "Explain how closures work in JavaScript" --- +### tui + +Start the OpenCode terminal user interface. + +```bash +opencode [project] +``` + +#### Flags + +| Flag | Short | Description | +| ------------ | ----- | ------------------------------------------ | +| `--continue` | `-c` | Continue the last session | +| `--session` | `-s` | Session ID to continue | +| `--prompt` | `-p` | Prompt to use | +| `--model` | `-m` | Model to use in the form of provider/model | +| `--agent` | | Agent to use | +| `--port` | | Port to listen on | +| `--hostname` | | Hostname to listen on | + +--- + ## Commands The OpenCode CLI also has the following commands. @@ -164,13 +186,17 @@ opencode run Explain the use of context in Go #### Flags -| Flag | Short | Description | -| ------------ | ----- | ------------------------------------------ | -| `--continue` | `-c` | Continue the last session | -| `--session` | `-s` | Session ID to continue | -| `--share` | | Share the session | -| `--model` | `-m` | Model to use in the form of provider/model | -| `--agent` | | Agent to use | +| Flag | Short | Description | +| ------------ | ----- | ------------------------------------------------------------------ | +| `--command` | | The command to run, use message for args | +| `--continue` | `-c` | Continue the last session | +| `--session` | `-s` | Session ID to continue | +| `--share` | | Share the session | +| `--model` | `-m` | Model to use in the form of provider/model | +| `--agent` | | Agent to use | +| `--file` | `-f` | File(s) to attach to message | +| `--format` | | Format: default (formatted) or json (raw JSON events) | +| `--title` | | Title for the session (uses truncated prompt if no value provided) | --- @@ -189,7 +215,7 @@ This starts an HTTP server that provides API access to opencode functionality wi | Flag | Short | Description | | ------------ | ----- | --------------------- | | `--port` | `-p` | Port to listen on | -| `--hostname` | `-h` | Hostname to listen on | +| `--hostname` | | Hostname to listen on | --- @@ -221,18 +247,13 @@ opencode upgrade v0.1.48 --- -## Flags +## Global Flags The opencode CLI takes the following global flags. -| Flag | Short | Description | -| -------------- | ----- | ------------------------------------------ | -| `--help` | `-h` | Display help | -| `--version` | | Print version number | -| `--print-logs` | | Print logs to stderr | -| `--log-level` | | Log level (DEBUG, INFO, WARN, ERROR) | -| `--prompt` | `-p` | Prompt to use | -| `--model` | `-m` | Model to use in the form of provider/model | -| `--agent` | | Agent to use | -| `--port` | | Port to listen on | -| `--hostname` | | Hostname to listen on | +| Flag | Short | Description | +| -------------- | ----- | ------------------------------------ | +| `--help` | `-h` | Display help | +| `--version` | `-v` | Print version number | +| `--print-logs` | | Print logs to stderr | +| `--log-level` | | Log level (DEBUG, INFO, WARN, ERROR) | |