summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src/content/docs
diff options
context:
space:
mode:
authorDax <[email protected]>2025-07-07 15:53:43 -0400
committerGitHub <[email protected]>2025-07-07 15:53:43 -0400
commitf884766445bbf1fbce11f1db4bc6174e72d9baa5 (patch)
treee7d9e7b3d8efc8bed249f9d29e2d8fb838a275f2 /packages/web/src/content/docs
parent76b2e4539cb97bae5812ed2d832ce49d02e70c64 (diff)
downloadopencode-f884766445bbf1fbce11f1db4bc6174e72d9baa5.tar.gz
opencode-f884766445bbf1fbce11f1db4bc6174e72d9baa5.zip
v2 message format and upgrade to ai sdk v5 (#743)
Co-authored-by: GitHub Action <[email protected]> Co-authored-by: Liang-Shih Lin <[email protected]> Co-authored-by: Dominik Engelhardt <[email protected]> Co-authored-by: Jay V <[email protected]> Co-authored-by: adamdottv <[email protected]>
Diffstat (limited to 'packages/web/src/content/docs')
-rw-r--r--packages/web/src/content/docs/docs/cli.mdx22
-rw-r--r--packages/web/src/content/docs/docs/config.mdx7
-rw-r--r--packages/web/src/content/docs/docs/index.mdx26
-rw-r--r--packages/web/src/content/docs/docs/rules.mdx3
-rw-r--r--packages/web/src/content/docs/docs/themes.mdx26
5 files changed, 36 insertions, 48 deletions
diff --git a/packages/web/src/content/docs/docs/cli.mdx b/packages/web/src/content/docs/docs/cli.mdx
index 49d343bee..57e595212 100644
--- a/packages/web/src/content/docs/docs/cli.mdx
+++ b/packages/web/src/content/docs/docs/cli.mdx
@@ -39,12 +39,12 @@ 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 |
+| 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 |
---
@@ -122,8 +122,8 @@ opencode upgrade v0.1.48
The opencode CLI takes the following flags.
-| Flag | Short | Description |
-| ----------------- | ----- | --------------------- |
-| `--help` | `-h` | Display help |
-| `--version` | | Print version number |
-| `--print-logs` | | Print logs to stderr |
+| Flag | Short | Description |
+| -------------- | ----- | -------------------- |
+| `--help` | `-h` | Display help |
+| `--version` | | Print version number |
+| `--print-logs` | | Print logs to stderr |
diff --git a/packages/web/src/content/docs/docs/config.mdx b/packages/web/src/content/docs/docs/config.mdx
index d88749c62..40583ea0a 100644
--- a/packages/web/src/content/docs/docs/config.mdx
+++ b/packages/web/src/content/docs/docs/config.mdx
@@ -39,7 +39,7 @@ You can configure the providers and models you want to use in your opencode conf
```json title="opencode.json"
{
"$schema": "https://opencode.ai/config.json",
- "provider": { },
+ "provider": {},
"model": ""
}
```
@@ -70,7 +70,7 @@ You can customize your keybinds through the `keybinds` option.
```json title="opencode.json"
{
"$schema": "https://opencode.ai/config.json",
- "keybinds": { }
+ "keybinds": {}
}
```
@@ -85,7 +85,7 @@ You can configure MCP servers you want to use through the `mcp` option.
```json title="opencode.json"
{
"$schema": "https://opencode.ai/config.json",
- "mcp": { }
+ "mcp": {}
}
```
@@ -105,6 +105,7 @@ You can disable providers that are loaded automatically through the `disabled_pr
```
The `disabled_providers` option accepts an array of provider IDs. When a provider is disabled:
+
- It won't be loaded even if environment variables are set
- It won't be loaded even if API keys are configured through `opencode auth login`
- The provider's models won't appear in the model selection list
diff --git a/packages/web/src/content/docs/docs/index.mdx b/packages/web/src/content/docs/docs/index.mdx
index b39ce452c..9ea95844a 100644
--- a/packages/web/src/content/docs/docs/index.mdx
+++ b/packages/web/src/content/docs/docs/index.mdx
@@ -3,7 +3,7 @@ title: Intro
description: Get started with opencode.
---
-import { Tabs, TabItem } from '@astrojs/starlight/components';
+import { Tabs, TabItem } from "@astrojs/starlight/components"
[**opencode**](/) is an AI coding agent built for the terminal. It features:
@@ -21,26 +21,10 @@ import { Tabs, TabItem } from '@astrojs/starlight/components';
## Install
<Tabs>
- <TabItem label="npm">
- ```bash
- npm install -g opencode-ai
- ```
- </TabItem>
- <TabItem label="Bun">
- ```bash
- bun install -g opencode-ai
- ```
- </TabItem>
- <TabItem label="pnpm">
- ```bash
- pnpm install -g opencode-ai
- ```
- </TabItem>
- <TabItem label="Yarn">
- ```bash
- yarn global add opencode-ai
- ```
- </TabItem>
+ <TabItem label="npm">```bash npm install -g opencode-ai ```</TabItem>
+ <TabItem label="Bun">```bash bun install -g opencode-ai ```</TabItem>
+ <TabItem label="pnpm">```bash pnpm install -g opencode-ai ```</TabItem>
+ <TabItem label="Yarn">```bash yarn global add opencode-ai ```</TabItem>
</Tabs>
You can also install the opencode binary through the following.
diff --git a/packages/web/src/content/docs/docs/rules.mdx b/packages/web/src/content/docs/docs/rules.mdx
index b7818d71b..b1b55b026 100644
--- a/packages/web/src/content/docs/docs/rules.mdx
+++ b/packages/web/src/content/docs/docs/rules.mdx
@@ -31,17 +31,20 @@ You can also just create this file manually. Here's an example of some things yo
This is an SST v3 monorepo with TypeScript. The project uses bun workspaces for package management.
## Project Structure
+
- `packages/` - Contains all workspace packages (functions, core, web, etc.)
- `infra/` - Infrastructure definitions split by service (storage.ts, api.ts, web.ts)
- `sst.config.ts` - Main SST configuration with dynamic imports
## Code Standards
+
- Use TypeScript with strict mode enabled
- Shared code goes in `packages/core/` with proper exports configuration
- Functions go in `packages/functions/`
- Infrastructure should be split into logical files in `infra/`
## Monorepo Conventions
+
- Import shared modules using workspace names: `@my-app/core/example`
```
diff --git a/packages/web/src/content/docs/docs/themes.mdx b/packages/web/src/content/docs/docs/themes.mdx
index da612284e..125591532 100644
--- a/packages/web/src/content/docs/docs/themes.mdx
+++ b/packages/web/src/content/docs/docs/themes.mdx
@@ -13,18 +13,18 @@ By default, opencode uses our own `opencode` theme.
opencode comes with several built-in themes.
-| Name | Description |
-| --- | --- |
-| `system` | Adapts to your terminal's background color |
-| `tokyonight` | Based on the Tokyonight theme |
-| `everforest` | Based on the Everforest theme |
-| `ayu` | Based on the Ayu dark theme |
-| `catppuccin` | Based on the Catppuccin theme |
-| `gruvbox` | Based on the Gruvbox theme |
-| `kanagawa` | Based on the Kanagawa theme |
-| `nord` | Based on the Nord theme |
-| `matrix` | Hacker-style green on black theme |
-| `one-dark` | Based on the Atom One Dark theme |
+| Name | Description |
+| ------------ | ------------------------------------------ |
+| `system` | Adapts to your terminal's background color |
+| `tokyonight` | Based on the Tokyonight theme |
+| `everforest` | Based on the Everforest theme |
+| `ayu` | Based on the Ayu dark theme |
+| `catppuccin` | Based on the Catppuccin theme |
+| `gruvbox` | Based on the Gruvbox theme |
+| `kanagawa` | Based on the Kanagawa theme |
+| `nord` | Based on the Nord theme |
+| `matrix` | Hacker-style green on black theme |
+| `one-dark` | Based on the Atom One Dark theme |
And more, we are constantly adding new themes.
@@ -61,7 +61,7 @@ You can select a theme by bringing up the theme select with the `/theme` command
## Custom themes
-opencode supports a flexible JSON-based theme system that allows users to create and customize themes easily.
+opencode supports a flexible JSON-based theme system that allows users to create and customize themes easily.
---