From b4ac938c3dc340b03dce1303f98f2e6f0a03b198 Mon Sep 17 00:00:00 2001 From: Dax Raad Date: Thu, 17 Sep 2026 10:10:20 -0400 Subject: [PATCH] docs: improve installation guide --- .../www/src/docs/components/CodeTabs.astro | 89 +++++++++++++++++++ .../www/src/docs/components/DocsPage.astro | 3 +- services/www/src/docs/content/index.mdx | 64 ++++++++++--- services/www/src/docs/styles/global.css | 42 +++++++++ 4 files changed, 183 insertions(+), 15 deletions(-) create mode 100644 services/www/src/docs/components/CodeTabs.astro diff --git a/services/www/src/docs/components/CodeTabs.astro b/services/www/src/docs/components/CodeTabs.astro new file mode 100644 index 00000000000..f3e1367a0cc --- /dev/null +++ b/services/www/src/docs/components/CodeTabs.astro @@ -0,0 +1,89 @@ +--- +import CodeBlock from "./CodeBlock.astro" + +interface Props { + id: string + label: string + tabs: Array<{ + label: string + code: string + }> +} +--- + +
+
+ { + Astro.props.tabs.map((tab, index) => ( + + )) + } +
+ { + Astro.props.tabs.map((tab, index) => ( + + )) + } +
+ + diff --git a/services/www/src/docs/components/DocsPage.astro b/services/www/src/docs/components/DocsPage.astro index d8401b98cbb..179f124483d 100644 --- a/services/www/src/docs/components/DocsPage.astro +++ b/services/www/src/docs/components/DocsPage.astro @@ -4,6 +4,7 @@ import Callout from "./Callout.astro" import Card from "./Card.astro" import CardGroup from "./CardGroup.astro" import CodeBlock from "./CodeBlock.astro" +import CodeTabs from "./CodeTabs.astro" import DocsLayout from "../layouts/DocsLayout.astro" interface Props { @@ -21,5 +22,5 @@ const rendered = await render(entry) headings={rendered.headings} showTableOfContents={entry.data.tableOfContents !== false} > - + diff --git a/services/www/src/docs/content/index.mdx b/services/www/src/docs/content/index.mdx index 3985459f896..4c7a518a72c 100644 --- a/services/www/src/docs/content/index.mdx +++ b/services/www/src/docs/content/index.mdx @@ -2,28 +2,64 @@ title: "Intro" --- -These docs describe OpenCode and its APIs, configuration, and plugin system. +OpenCode is an open source AI coding agent. It’s available as a terminal-based interface, desktop app, or web app. -OpenCode installs and runs as `opencode`. -## Install +## CLI -
- -
+ The npm package uses a trusted postinstall script to select the native `opencode` binary for your platform. The Bun and pnpm commands above explicitly allow that script to run. -Docker images use versioned tags, for example `ghcr.io/anomalyco/opencode:2.0.0`. +Windows package managers are not supported. -Homebrew, AUR, Windows package managers, and standalone binaries are not supported. + +Download a standalone CLI binary for your platform. + +- **macOS:** [Apple silicon](https://opencode.ai/files/bin/2.0.6/opencode-darwin-arm64.zip) · [Intel](https://opencode.ai/files/bin/2.0.6/opencode-darwin-x64.zip) · [Intel (baseline)](https://opencode.ai/files/bin/2.0.6/opencode-darwin-x64-baseline.zip) +- **Windows:** [ARM64](https://opencode.ai/files/bin/2.0.6/opencode-windows-arm64.zip) · [x64](https://opencode.ai/files/bin/2.0.6/opencode-windows-x64.zip) · [x64 (baseline)](https://opencode.ai/files/bin/2.0.6/opencode-windows-x64-baseline.zip) +- **Linux (glibc):** [ARM64](https://opencode.ai/files/bin/2.0.6/opencode-linux-arm64.tar.gz) · [x64](https://opencode.ai/files/bin/2.0.6/opencode-linux-x64.tar.gz) · [x64 (baseline)](https://opencode.ai/files/bin/2.0.6/opencode-linux-x64-baseline.tar.gz) +- **Linux (musl):** [ARM64](https://opencode.ai/files/bin/2.0.6/opencode-linux-arm64-musl.tar.gz) · [x64](https://opencode.ai/files/bin/2.0.6/opencode-linux-x64-musl.tar.gz) · [x64 (baseline)](https://opencode.ai/files/bin/2.0.6/opencode-linux-x64-baseline-musl.tar.gz) + +## Desktop + +Download the latest OpenCode Desktop build for your platform. + +- **macOS:** [Apple silicon](https://opencode.ai/files/bin/2.0.6/opencode-desktop-mac-arm64.dmg) · [Intel](https://opencode.ai/files/bin/2.0.6/opencode-desktop-mac-x64.dmg) +- **Windows:** [x64](https://opencode.ai/files/bin/2.0.6/opencode-desktop-win-x64.exe) · [ARM64](https://opencode.ai/files/bin/2.0.6/opencode-desktop-win-arm64.exe) +- **Linux (.deb):** [x64](https://opencode.ai/files/bin/2.0.6/opencode-desktop-linux-amd64.deb) · [ARM64](https://opencode.ai/files/bin/2.0.6/opencode-desktop-linux-arm64.deb) +- **Linux (.rpm):** [x64](https://opencode.ai/files/bin/2.0.6/opencode-desktop-linux-x86_64.rpm) · [ARM64](https://opencode.ai/files/bin/2.0.6/opencode-desktop-linux-aarch64.rpm) +- **Linux (AppImage):** [x64](https://opencode.ai/files/bin/2.0.6/opencode-desktop-linux-x86_64.AppImage) · [ARM64](https://opencode.ai/files/bin/2.0.6/opencode-desktop-linux-arm64.AppImage) + + +## Web + +Access the OpenCode web interface with the `opencode pair` command. + +```bash +$ opencode pair + + URLs http://127.0.0.1:49374 + Username opencode + Password ******** +``` + +## Docker + +Docker images use versioned tags, for example `ghcr.io/anomalyco/opencode:2.0.0`. --- diff --git a/services/www/src/docs/styles/global.css b/services/www/src/docs/styles/global.css index a6dd4549d65..4bcdd72a34a 100644 --- a/services/www/src/docs/styles/global.css +++ b/services/www/src/docs/styles/global.css @@ -1002,6 +1002,48 @@ main { font-size: 0.75rem; } +.docs-code-tabs { + margin-bottom: 1.5rem; + border: 1px solid var(--border); +} + +.docs-code-tabs-list { + display: flex; + border-bottom: 1px solid var(--border); + flex-wrap: wrap; +} + +.docs-code-tabs-list button { + margin-bottom: -1px; + padding: 0.5rem 0.875rem; + flex-shrink: 0; + cursor: pointer; + border: 0; + border-bottom: 1px solid transparent; + background: transparent; + color: var(--muted); + font-size: 0.75rem; +} + +.docs-code-tabs-list button:hover, +.docs-code-tabs-list button[aria-selected="true"] { + color: var(--foreground); +} + +.docs-code-tabs-list button[aria-selected="true"] { + border-bottom-color: var(--foreground); +} + +.docs-code-tabs-list button:focus-visible { + outline: 1px solid var(--foreground); + outline-offset: -3px; +} + +.docs-code-tabs .docs-code-block pre { + margin: 0; + border: 0; +} + .prose h1 button { display: inline-flex; padding: 0;