Skip to content

docs(cli): document the --completions flag #57622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oke3 wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs(cli): document the --completions flag #57622

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions services/www/src/docs/content/cli/commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,30 @@ description: "Reference for the opencode command line."

Every command accepts `--help` for its full flag list, for example `opencode run --help`. Some server-backed commands accept `--standalone` to run a private server or `--server <url>` to target a specific one; check the command's help for its supported flags.

## Shell completion

The `--completions` global flag prints a completion script for your shell. It supports `bash`, `zsh`, `fish` and `sh`.

For bash, append the script to your profile.

```bash
$ opencode --completions bash >> ~/.bashrc
```

For zsh, write the script to your completions directory and add that directory to your `fpath`.

```bash
$ opencode --completions zsh > ~/.zsh/completions/_opencode
```

For fish, write the script to the fish completions directory.

```bash
$ opencode --completions fish > ~/.config/fish/completions/opencode.fish
```

The `sh` script is the bash one.

## run

Sends a message and prints the reply without opening the interactive interface.
Expand Down
Loading