Skip to content

Commit 6378e6c

Browse files
committed
docs: rename opencode to OpenCode
1 parent 4159db4 commit 6378e6c

File tree

19 files changed

+133
-133
lines changed

19 files changed

+133
-133
lines changed

packages/web/src/content/docs/agents.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can switch between agents during a session or invoke them with the `@` menti
1515

1616
## Types
1717

18-
There are two types of agents in opencode; primary agents and subagents.
18+
There are two types of agents in OpenCode; primary agents and subagents.
1919

2020
---
2121

@@ -27,7 +27,7 @@ Primary agents are the main assistants you interact with directly. You can cycle
2727
You can use the **Tab** key to switch between primary agents during a session.
2828
:::
2929

30-
opencode comes with two built-in primary agents, **Build** and **Plan**. We'll
30+
OpenCode comes with two built-in primary agents, **Build** and **Plan**. We'll
3131
look at these below.
3232

3333
---
@@ -36,13 +36,13 @@ look at these below.
3636

3737
Subagents are specialized assistants that primary agents can invoke for specific tasks. You can also manually invoke them by **@ mentioning** them in your messages.
3838

39-
opencode comes with one built-in subagent, **General**. We'll look at this below.
39+
OpenCode comes with one built-in subagent, **General**. We'll look at this below.
4040

4141
---
4242

4343
## Built-in
4444

45-
opencode comes with two built-in primary agents and one built-in subagent.
45+
OpenCode comes with two built-in primary agents and one built-in subagent.
4646

4747
---
4848

@@ -245,7 +245,7 @@ Temperature values typically range from 0.0 to 1.0:
245245
}
246246
```
247247

248-
If no temperature is specified, opencode uses model-specific defaults; typically 0 for most models, 0.55 for Qwen models.
248+
If no temperature is specified, OpenCode uses model-specific defaults; typically 0 for most models, 0.55 for Qwen models.
249249

250250
---
251251

@@ -279,7 +279,7 @@ Specify a custom system prompt file for this agent with the `prompt` config. The
279279
}
280280
```
281281

282-
This path is relative to where the config file is located. So this works for both the global opencode config and the project specific config.
282+
This path is relative to where the config file is located. So this works for both the global OpenCode config and the project specific config.
283283

284284
---
285285

packages/web/src/content/docs/cli.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
title: CLI
3-
description: opencode CLI options and commands.
3+
description: OpenCode CLI options and commands.
44
---
55

66
import { Tabs, TabItem } from "@astrojs/starlight/components"
77

8-
The opencode CLI by default starts the [TUI](/docs/tui) when run without any arguments.
8+
The OpenCode CLI by default starts the [TUI](/docs/tui) when run without any arguments.
99

1010
```bash
1111
opencode
1212
```
1313

14-
But it also accepts commands as documented on this page. This allows you to interact with opencode programmatically.
14+
But it also accepts commands as documented on this page. This allows you to interact with OpenCode programmatically.
1515

1616
```bash
1717
opencode run "Explain how closures work in JavaScript"
@@ -21,13 +21,13 @@ opencode run "Explain how closures work in JavaScript"
2121

2222
## Commands
2323

24-
The opencode CLI also has the following commands.
24+
The OpenCode CLI also has the following commands.
2525

2626
---
2727

2828
### agent
2929

30-
Manage agents for opencode.
30+
Manage agents for OpenCode.
3131

3232
```bash
3333
opencode agent [command]
@@ -59,13 +59,13 @@ opencode auth [command]
5959

6060
#### login
6161

62-
opencode is powered by the provider list at [Models.dev](https://models.dev), so you can use `opencode auth login` to configure API keys for any provider you'd like to use. This is stored in `~/.local/share/opencode/auth.json`.
62+
OpenCode is powered by the provider list at [Models.dev](https://models.dev), so you can use `opencode auth login` to configure API keys for any provider you'd like to use. This is stored in `~/.local/share/opencode/auth.json`.
6363

6464
```bash
6565
opencode auth login
6666
```
6767

68-
When opencode starts up it loads the providers from the credentials file. And if there are any keys defined in your environments or a `.env` file in your project.
68+
When OpenCode starts up it loads the providers from the credentials file. And if there are any keys defined in your environments or a `.env` file in your project.
6969

7070
---
7171

packages/web/src/content/docs/commands.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ Use the command by typing `/` followed by the command name.
4242

4343
## Configure
4444

45-
You can add custom commands through the opencode config or by creating markdown files in the `command/` directory.
45+
You can add custom commands through the OpenCode config or by creating markdown files in the `command/` directory.
4646

4747
---
4848

4949
### JSON
5050

51-
Use the `command` option in your opencode [config](/docs/config):
51+
Use the `command` option in your OpenCode [config](/docs/config):
5252

5353
```json title="opencode.jsonc" {4-12}
5454
{

packages/web/src/content/docs/config.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: Config
3-
description: Using the opencode JSON config.
3+
description: Using the OpenCode JSON config.
44
---
55

6-
You can configure opencode using a JSON config file.
6+
You can configure OpenCode using a JSON config file.
77

88
---
99

1010
## Format
1111

12-
opencode supports both **JSON** and **JSONC** (JSON with Comments) formats.
12+
OpenCode supports both **JSON** and **JSONC** (JSON with Comments) formats.
1313

1414
```jsonc title="opencode.jsonc"
1515
{
@@ -32,7 +32,7 @@ different order of precedence.
3232

3333
### Global
3434

35-
Place your global opencode config in `~/.config/opencode/opencode.json`. You'll want to use the global config for things like themes, providers, or keybinds.
35+
Place your global OpenCode config in `~/.config/opencode/opencode.json`. You'll want to use the global config for things like themes, providers, or keybinds.
3636

3737
---
3838

@@ -44,7 +44,7 @@ You can also add a `opencode.json` in your project. It takes precedence over the
4444
Place project specific config in the root of your project.
4545
:::
4646

47-
When opencode starts up, it looks for a config file in the current directory or traverse up to the nearest Git directory.
47+
When OpenCode starts up, it looks for a config file in the current directory or traverse up to the nearest Git directory.
4848

4949
This is also safe to be checked into Git and uses the same schema as the global one.
5050

@@ -71,7 +71,7 @@ Your editor should be able to validate and autocomplete based on the schema.
7171

7272
### Models
7373

74-
You can configure the providers and models you want to use in your opencode config through the `provider`, `model` and `small_model` options.
74+
You can configure the providers and models you want to use in your OpenCode config through the `provider`, `model` and `small_model` options.
7575

7676
```json title="opencode.json"
7777
{
@@ -82,15 +82,15 @@ You can configure the providers and models you want to use in your opencode conf
8282
}
8383
```
8484

85-
The `small_model` option configures a separate model for lightweight tasks like title generation. By default, opencode tries to use a cheaper model if one is available from your provider, otherwise it falls back to your main model.
85+
The `small_model` option configures a separate model for lightweight tasks like title generation. By default, OpenCode tries to use a cheaper model if one is available from your provider, otherwise it falls back to your main model.
8686

8787
You can also configure [local models](/docs/models#local). [Learn more](/docs/models).
8888

8989
---
9090

9191
### Themes
9292

93-
You can configure the theme you want to use in your opencode config through the `theme` option.
93+
You can configure the theme you want to use in your OpenCode config through the `theme` option.
9494

9595
```json title="opencode.json"
9696
{
@@ -193,7 +193,7 @@ You can customize your keybinds through the `keybinds` option.
193193

194194
### Autoupdate
195195

196-
opencode will automatically download any new updates when it starts up. You can disable this with the `autoupdate` option.
196+
OpenCode will automatically download any new updates when it starts up. You can disable this with the `autoupdate` option.
197197

198198
```json title="opencode.json"
199199
{

packages/web/src/content/docs/enterprise.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Enterprise
3-
description: Using opencode in your organization.
3+
description: Using OpenCode in your organization.
44
---
55

66
import config from "../../../config.mjs"
77
export const email = `mailto:${config.email}`
88

9-
opencode does not store any of your code or context data. This makes it easy for
10-
you to use opencode at your organization.
9+
OpenCode does not store any of your code or context data. This makes it easy for
10+
you to use OpenCode at your organization.
1111

1212
To get started, we recommend:
1313

@@ -18,7 +18,7 @@ To get started, we recommend:
1818

1919
## Trial
2020

21-
Since opencode is open source and does not store any of your code or context data, your developers can simply [get started](/docs/) and carry out a trial.
21+
Since OpenCode is open source and does not store any of your code or context data, your developers can simply [get started](/docs/) and carry out a trial.
2222

2323
---
2424

packages/web/src/content/docs/formatters.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
title: Formatters
3-
description: opencode uses language specific formatters.
3+
description: OpenCode uses language specific formatters.
44
---
55

6-
opencode automatically formats files after they are written or edited using language-specific formatters. This ensures that the code that is generated follows the code styles of your project.
6+
OpenCode automatically formats files after they are written or edited using language-specific formatters. This ensures that the code that is generated follows the code styles of your project.
77

88
---
99

1010
## Built-in
1111

12-
opencode comes with several built-in formatters for popular languages and frameworks. Below is a list of the formatters, supported file extensions, and commands or config options it needs.
12+
OpenCode comes with several built-in formatters for popular languages and frameworks. Below is a list of the formatters, supported file extensions, and commands or config options it needs.
1313

1414
| Formatter | Extensions | Requirements |
1515
| -------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------- |
@@ -25,13 +25,13 @@ opencode comes with several built-in formatters for popular languages and framew
2525
| standardrb | .rb, .rake, .gemspec, .ru | `standardrb` command available |
2626
| htmlbeautifier | .erb, .html.erb | `htmlbeautifier` command available |
2727

28-
So if your project has `prettier` in your `package.json`, opencode will automatically use it.
28+
So if your project has `prettier` in your `package.json`, OpenCode will automatically use it.
2929

3030
---
3131

3232
## How it works
3333

34-
When opencode writes or edits a file, it:
34+
When OpenCode writes or edits a file, it:
3535

3636
1. Checks the file extension against all enabled formatters.
3737
2. Runs the appropriate formatter command on the file.
@@ -43,7 +43,7 @@ This process happens in the background, ensuring your code styles are maintained
4343

4444
## Configure
4545

46-
You can customize formatters through the `formatter` section in your opencode config.
46+
You can customize formatters through the `formatter` section in your OpenCode config.
4747

4848
```json title="opencode.json"
4949
{

packages/web/src/content/docs/ide.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
22
title: IDE
3-
description: The opencode extension for VS Code, Cursor, and other IDEs
3+
description: The OpenCode extension for VS Code, Cursor, and other IDEs
44
---
55

6-
opencode integrates with VS Code, Cursor, or any IDE that supports a terminal. Just run `opencode` in the terminal to get started.
6+
OpenCode integrates with VS Code, Cursor, or any IDE that supports a terminal. Just run `opencode` in the terminal to get started.
77

88
---
99

1010
## Usage
1111

12-
- **Quick Launch**: Use `Cmd+Esc` (Mac) or `Ctrl+Esc` (Windows/Linux) to open opencode in a split terminal view, or focus an existing terminal session if one is already running.
13-
- **New Session**: Use `Cmd+Shift+Esc` (Mac) or `Ctrl+Shift+Esc` (Windows/Linux) to start a new opencode terminal session, even if one is already open. You can also click the opencode button in the UI.
14-
- **Context Awareness**: Automatically share your current selection or tab with opencode.
12+
- **Quick Launch**: Use `Cmd+Esc` (Mac) or `Ctrl+Esc` (Windows/Linux) to open OpenCode in a split terminal view, or focus an existing terminal session if one is already running.
13+
- **New Session**: Use `Cmd+Shift+Esc` (Mac) or `Ctrl+Shift+Esc` (Windows/Linux) to start a new OpenCode terminal session, even if one is already open. You can also click the OpenCode button in the UI.
14+
- **Context Awareness**: Automatically share your current selection or tab with OpenCode.
1515
- **File Reference Shortcuts**: Use `Cmd+Option+K` (Mac) or `Alt+Ctrl+K` (Linux/Windows) to insert file references. For example, `@File#L37-42`.
1616

1717
---
1818

1919
## Installation
2020

21-
To install opencode on VS Code and popular forks like Cursor, Windsurf, VSCodium:
21+
To install OpenCode on VS Code and popular forks like Cursor, Windsurf, VSCodium:
2222

2323
1. Open VS Code
2424
2. Open the integrated terminal
@@ -30,7 +30,7 @@ If on the other hand you want to use your own IDE when you run `/editor` or `/ex
3030

3131
### Manual Install
3232

33-
Search for **opencode** in the Extension Marketplace and click **Install**.
33+
Search for **OpenCode** in the Extension Marketplace and click **Install**.
3434

3535
---
3636

0 commit comments

Comments
 (0)