docs: update cli
This commit is contained in:
@@ -101,22 +101,16 @@ Both the `/editor` and `/export` commands use the editor specified in your `EDIT
|
|||||||
|
|
||||||
<Tabs>
|
<Tabs>
|
||||||
<TabItem label="Linux/macOS">
|
<TabItem label="Linux/macOS">
|
||||||
```bash
|
```bash export EDITOR=nano # or vim, code, etc. ``` To make it permanent, add this to your shell profile;
|
||||||
export EDITOR=nano # or vim, code, etc.
|
`~/.bashrc`, `~/.zshrc`, etc.
|
||||||
```
|
|
||||||
To make it permanent, add this to your shell profile; `~/.bashrc`, `~/.zshrc`, etc.
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem label="Windows (CMD)">
|
<TabItem label="Windows (CMD)">
|
||||||
```bash
|
```bash set EDITOR=notepad # or code, vim, etc. ``` To make it permanent, use **System Properties** > **Environment
|
||||||
set EDITOR=notepad # or code, vim, etc.
|
Variables**.
|
||||||
```
|
|
||||||
To make it permanent, use **System Properties** > **Environment Variables**.
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
<TabItem label="Windows (PowerShell)">
|
<TabItem label="Windows (PowerShell)">
|
||||||
```bash
|
```bash $env:EDITOR = "notepad" # or "code", "vim", etc. ``` To make it permanent, add this to your PowerShell
|
||||||
$env:EDITOR = "notepad" # or "code", "vim", etc.
|
profile.
|
||||||
```
|
|
||||||
To make it permanent, add this to your PowerShell profile.
|
|
||||||
</TabItem>
|
</TabItem>
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
@@ -136,28 +130,25 @@ The opencode CLI also has the following commands.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### run
|
### agent
|
||||||
|
|
||||||
Run opencode in non-interactive mode by passing a prompt directly.
|
Manage agents for opencode.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
opencode run [message..]
|
opencode agent [command]
|
||||||
```
|
```
|
||||||
|
|
||||||
This is useful for scripting, automation, or when you want a quick answer without launching the full TUI. For example.
|
---
|
||||||
|
|
||||||
```bash "opencode run"
|
#### create
|
||||||
opencode run Explain the use of context in Go
|
|
||||||
|
Create a new agent with custom configuration.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode agent create
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Flags
|
This command will guide you through creating a new agent with a custom system prompt and tool configuration.
|
||||||
|
|
||||||
| 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 |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -209,6 +200,102 @@ opencode auth logout
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### github
|
||||||
|
|
||||||
|
Manage the GitHub agent for repository automation.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode github [command]
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### install
|
||||||
|
|
||||||
|
Install the GitHub agent in your repository.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode github install
|
||||||
|
```
|
||||||
|
|
||||||
|
This sets up the necessary GitHub Actions workflow and guides you through the configuration process. [Learn more](/docs/github).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
#### run
|
||||||
|
|
||||||
|
Run the GitHub agent. This is typically used in GitHub Actions.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode github run
|
||||||
|
```
|
||||||
|
|
||||||
|
##### Flags
|
||||||
|
|
||||||
|
| Flag | Description |
|
||||||
|
| --------- | ------------------------------------------------ |
|
||||||
|
| `--event` | GitHub mock event to run the agent for |
|
||||||
|
| `--token` | GitHub personal access token |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### models
|
||||||
|
|
||||||
|
List all available models from configured providers.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode models
|
||||||
|
```
|
||||||
|
|
||||||
|
This command displays all models available across your configured providers in the format `provider/model`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### run
|
||||||
|
|
||||||
|
Run opencode in non-interactive mode by passing a prompt directly.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode run [message..]
|
||||||
|
```
|
||||||
|
|
||||||
|
This is useful for scripting, automation, or when you want a quick answer without launching the full TUI. For example.
|
||||||
|
|
||||||
|
```bash "opencode run"
|
||||||
|
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 |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### serve
|
||||||
|
|
||||||
|
Start a headless opencode server for API access.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode serve
|
||||||
|
```
|
||||||
|
|
||||||
|
This starts an HTTP server that provides API access to opencode functionality without the TUI interface.
|
||||||
|
|
||||||
|
#### Flags
|
||||||
|
|
||||||
|
| Flag | Short | Description |
|
||||||
|
| ------------ | ----- | ------------------------------------------ |
|
||||||
|
| `--port` | `-p` | Port to listen on |
|
||||||
|
| `--hostname` | `-h` | Hostname to listen on |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### upgrade
|
### upgrade
|
||||||
|
|
||||||
Updates opencode to the latest version or a specific version.
|
Updates opencode to the latest version or a specific version.
|
||||||
@@ -229,17 +316,26 @@ To upgrade to a specific version.
|
|||||||
opencode upgrade v0.1.48
|
opencode upgrade v0.1.48
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Flags
|
||||||
|
|
||||||
|
| Flag | Short | Description |
|
||||||
|
| ---------- | ----- | --------------------------------------------------------- |
|
||||||
|
| `--method` | `-m` | The installation method that was used; curl, npm, pnpm, bun, brew |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Flags
|
## Flags
|
||||||
|
|
||||||
The opencode CLI takes the following flags.
|
The opencode CLI takes the following global flags.
|
||||||
|
|
||||||
| Flag | Short | Description |
|
| Flag | Short | Description |
|
||||||
| -------------- | ----- | ------------------------------------------ |
|
| -------------- | ----- | ------------------------------------------ |
|
||||||
| `--help` | `-h` | Display help |
|
| `--help` | `-h` | Display help |
|
||||||
| `--version` | | Print version number |
|
| `--version` | | Print version number |
|
||||||
| `--print-logs` | | Print logs to stderr |
|
| `--print-logs` | | Print logs to stderr |
|
||||||
|
| `--log-level` | | Log level (DEBUG, INFO, WARN, ERROR) |
|
||||||
| `--prompt` | `-p` | Prompt to use |
|
| `--prompt` | `-p` | Prompt to use |
|
||||||
| `--model` | `-m` | Model to use in the form of provider/model |
|
| `--model` | `-m` | Model to use in the form of provider/model |
|
||||||
| `--mode` | | Mode to use |
|
| `--mode` | | Mode to use |
|
||||||
|
| `--port` | | Port to listen on |
|
||||||
|
| `--hostname` | | Hostname to listen on |
|
||||||
|
|||||||
Reference in New Issue
Block a user