docs: add tui doc

jayair · jayair · commit 2dea8f0f6bc3 · 2025-08-18T13:31:01.000-04:00
diff --git a/.opencode/agent/docs.md b/.opencode/agent/docs.md
@@ -1,14 +1,26 @@
 ---
-model: openai/gpt-5
-reasoningEffort: medium
 description: ALWAYS use this when writing docs
 ---
 
 You are an expert technical documentation writer
 
 You are not verbose
 
-Every chunk of text should be followed by an example or something besides text
-to look at.
+The title of the page should be a word or a 2-3 word phrase
 
-Chunks of text should not be more than 2 sentences long.
+The description should be one short line, should not start with "The", should
+avoid repeating the title of the page, should be 5-10 words long
+
+Chunks of text should not be more than 2 sentences long
+
+Each section is spearated by a divider of 3 dashes
+
+The section titles are short with only the first letter of the word capitalized
+
+The section titles are in the imperative mood
+
+The section titles should not repeat the term used in the page title, for
+example, if the page title is "Models", avoid using a section title like "Add
+new models". This might be unavoidable in some cases, but try to avoid it.
+
+Check out the /packages/web/src/content/docs/docs/index.mdx as an example.
diff --git a/packages/web/astro.config.mjs b/packages/web/astro.config.mjs
@@ -69,7 +69,7 @@ export default defineConfig({
 
         {
           label: "Usage",
-          items: ["docs/cli", "docs/ide", "docs/share", "docs/github"],
+          items: ["docs/tui", "docs/cli", "docs/ide", "docs/share", "docs/github"],
         },
 
         {
diff --git a/packages/web/src/content/docs/docs/cli.mdx b/packages/web/src/content/docs/docs/cli.mdx
@@ -1,137 +1,16 @@
 ---
 title: CLI
-description: The opencode CLI options and commands.
+description: opencode CLI options and commands.
 ---
 
 import { Tabs, TabItem } from "@astrojs/starlight/components"
 
-Running the opencode CLI starts it for the current directory.
+The opencode CLI accepts commands as documented on this page. You can run any of the available commands to interact with opencode programmatically.
 
 ```bash
-opencode
+opencode run "Explain how closures work in JavaScript"
 ```
 
-Or you can start it for a specific working directory.
-
-```bash
-opencode /path/to/project
-```
-
----
-
-## Slash commands
-
-When using the opencode CLI, you can type `/` followed by a command name to quickly execute actions. For example:
-
-:::tip
-You can also use `@` to reference files in your messages.
-:::
-
-```bash frame="none"
-/help
-```
-
-Here are all available slash commands:
-
-- **`/help`**
-
-  Show the help dialog.
-
-- **`/editor`**
-
-  Open external editor for composing messages. Uses the editor set in your `EDITOR` environment variable. [Learn more](#editor-setup).
-
-- **`/export`**
-
-  Export current conversation to Markdown and open in your default editor. Uses the editor set in your `EDITOR` environment variable. [Learn more](#editor-setup).
-
-- **`/new`**
-
-  Start a new session. _Alias_: `/clear`
-
-- **`/sessions`**
-
-  List and switch between sessions. _Aliases_: `/resume`, `/continue`
-
-- **`/share`**
-
-  Share current session. [Learn more](/docs/share).
-
-- **`/unshare`**
-
-  Unshare current session. [Learn more](/docs/share#un-sharing).
-
-- **`/compact`**
-
-  Compact the current session. _Alias_: `/summarize`
-
-- **`/details`**
-
-  Toggle tool execution details.
-
-- **`/models`**
-
-  List available models.
-
-- **`/themes`**
-
-  List available themes.
-
-- **`/init`**
-
-  Create or update `AGENTS.md` file. [Learn more](/docs/rules).
-
-- **`/undo`**
-
-  Undo last message.
-
-- **`/redo`**
-
-  Redo message.
-
-- **`/exit`**
-
-  Exit opencode. _Aliases_: `/quit`, `/q`
-
----
-
-### Bash commands
-
-Start a line with `!` to run a shell command. The output is added to the conversation as a tool result.
-
-```bash frame="none"
-!ls -la
-```
-
----
-
-### Editor setup
-
-Both the `/editor` and `/export` commands use the editor specified in your `EDITOR` environment variable.
-
-<Tabs>
-  <TabItem label="Linux/macOS">
-    ```bash export EDITOR=nano # or vim, code, etc. ``` To make it permanent, add this to your shell profile;
-    `~/.bashrc`, `~/.zshrc`, etc.
-  </TabItem>
-  <TabItem label="Windows (CMD)">
-    ```bash set EDITOR=notepad # or code, vim, etc. ``` To make it permanent, use **System Properties** > **Environment
-    Variables**.
-  </TabItem>
-  <TabItem label="Windows (PowerShell)">
-    ```bash $env:EDITOR = "notepad" # or "code", "vim", etc. ``` To make it permanent, add this to your PowerShell
-    profile.
-  </TabItem>
-</Tabs>
-
-Popular editor options include:
-
-- `code` - Visual Studio Code
-- `vim` - Vim editor
-- `nano` - Nano editor
-- `notepad` - Windows Notepad
-- `subl` - Sublime Text
-
 ---
 
 ## Commands
diff --git a/packages/web/src/content/docs/docs/index.mdx b/packages/web/src/content/docs/docs/index.mdx
@@ -157,16 +157,16 @@ help.
 
 You can ask opencode to explain the codebase to you.
 
-```txt frame="none"
+:::tip
+Use the `@` key to fuzzy search for files in the project.
+:::
+
+```txt frame="none" "@packages/functions/src/api/index.ts"
 How is authentication handled in @packages/functions/src/api/index.ts
 ```
 
 This is helpful if there's a part of the codebase that you didn't work on.
 
-:::tip
-Use the `@` key to fuzzy search for files in the project.
-:::
-
 ---
 
 ### Add features
@@ -238,7 +238,7 @@ You can ask opencode to add new features to your project. Though we first recomm
 For more straightforward changes, you can ask opencode to directly build it
 without having to review the plan first.
 
-```txt frame="none"
+```txt frame="none" "@packages/functions/src/settings.ts" "@packages/functions/src/notes.ts"
 We need to add authentication to the /settings route. Take a look at how this is
 handled in the /notes route in @packages/functions/src/notes.ts and implement
 the same logic in @packages/functions/src/settings.ts
@@ -253,7 +253,7 @@ changes.
 
 Let's say you ask opencode to make some changes.
 
-```txt frame="none"
+```txt frame="none" "@packages/functions/src/api/index.ts"
 Can you refactor the function in @packages/functions/src/api/index.ts?
 ```
 
@@ -267,7 +267,7 @@ using the `/undo` command.
 opencode will now revert the changes you made and show your original message
 again.
 
-```txt frame="none"
+```txt frame="none" "@packages/functions/src/api/index.ts"
 Can you refactor the function in @packages/functions/src/api/index.ts?
 ```
 
diff --git a/packages/web/src/content/docs/docs/providers.mdx b/packages/web/src/content/docs/docs/providers.mdx
@@ -614,8 +614,6 @@ In this example:
 
 ### OpenAI
 
-https://platform.openai.com/api-keys
-
 1. Head over to the [OpenAI Platform console](https://platform.openai.com/api-keys), click **Create new secret key**, and copy the key.
 
 2. Run `opencode auth login` and select OpenAI.
diff --git a/packages/web/src/content/docs/docs/tui.mdx b/packages/web/src/content/docs/docs/tui.mdx

Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ export default defineConfig({`
`69`	`69`
`70`	`70`	`{`
`71`	`71`	`label: "Usage",`
`72`		`- items: ["docs/cli", "docs/ide", "docs/share", "docs/github"],`
	`72`	`+ items: ["docs/tui", "docs/cli", "docs/ide", "docs/share", "docs/github"],`
`73`	`73`	`},`
`74`	`74`
`75`	`75`	`{`