summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJay V <[email protected]>2025-07-09 20:24:09 -0400
committerJay V <[email protected]>2025-07-09 20:24:09 -0400
commit69cf1d7b7e00c93f2eedbb5ff2688578814c08b0 (patch)
treea781de8064f7a3493a79d70e9a3db81a52525be0
parent8e0a1d11672509aa30abf73fd9f82e219335e22e (diff)
downloadopencode-69cf1d7b7e00c93f2eedbb5ff2688578814c08b0.tar.gz
opencode-69cf1d7b7e00c93f2eedbb5ff2688578814c08b0.zip
docs: share doc
-rw-r--r--bun.lock4
-rw-r--r--packages/web/astro.config.mjs1
-rw-r--r--packages/web/package.json2
-rw-r--r--packages/web/src/content/docs/docs/cli.mdx2
-rw-r--r--packages/web/src/content/docs/docs/share.mdx103
-rw-r--r--packages/web/src/content/docs/docs/troubleshooting.mdx4
6 files changed, 113 insertions, 3 deletions
diff --git a/bun.lock b/bun.lock
index 8066b54a7..deefc4468 100644
--- a/bun.lock
+++ b/bun.lock
@@ -83,7 +83,7 @@
"sharp": "0.32.5",
"shiki": "3.4.2",
"solid-js": "1.9.7",
- "toolbeam-docs-theme": "0.4.1",
+ "toolbeam-docs-theme": "0.4.3",
},
"devDependencies": {
"@types/node": "catalog:",
@@ -1531,7 +1531,7 @@
"token-types": ["[email protected]", "", { "dependencies": { "@tokenizer/token": "^0.3.0", "ieee754": "^1.2.1" } }, "sha512-lbDrTLVsHhOMljPscd0yitpozq7Ga2M5Cvez5AjGg8GASBjtt6iERCAJ93yommPmz62fb45oFIXHEZ3u9bfJEA=="],
- "toolbeam-docs-theme": ["[email protected]", "", { "peerDependencies": { "@astrojs/starlight": "^0.34.3", "astro": "^5.7.13" } }, "sha512-lTI4dHZaVNQky29m7sb36Oy4tWPwxsCuFxFjF8hgGW0vpV+S6qPvI9SwsJFvdE/OHO5DoI7VMbryV1pxZHkkHQ=="],
+ "toolbeam-docs-theme": ["[email protected]", "", { "peerDependencies": { "@astrojs/starlight": "^0.34.3", "astro": "^5.7.13" } }, "sha512-3um/NsSq4xFeKbKrNGPHIzfTixwnEVvroqA8Q+lecnYHHJ5TtiYTggHDqewOW+I67t0J1IVBwVKUPjxiQfIcog=="],
"tr46": ["[email protected]", "", {}, "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw=="],
diff --git a/packages/web/astro.config.mjs b/packages/web/astro.config.mjs
index 713e09a11..537e9ed40 100644
--- a/packages/web/astro.config.mjs
+++ b/packages/web/astro.config.mjs
@@ -63,6 +63,7 @@ export default defineConfig({
"docs",
"docs/cli",
"docs/rules",
+ "docs/share",
"docs/config",
"docs/models",
"docs/themes",
diff --git a/packages/web/package.json b/packages/web/package.json
index bdd6467c0..9755b0124 100644
--- a/packages/web/package.json
+++ b/packages/web/package.json
@@ -30,7 +30,7 @@
"sharp": "0.32.5",
"shiki": "3.4.2",
"solid-js": "1.9.7",
- "toolbeam-docs-theme": "0.4.1"
+ "toolbeam-docs-theme": "0.4.3"
},
"devDependencies": {
"opencode": "workspace:*",
diff --git a/packages/web/src/content/docs/docs/cli.mdx b/packages/web/src/content/docs/docs/cli.mdx
index 57e595212..f0a0024ce 100644
--- a/packages/web/src/content/docs/docs/cli.mdx
+++ b/packages/web/src/content/docs/docs/cli.mdx
@@ -127,3 +127,5 @@ The opencode CLI takes the following flags.
| `--help` | `-h` | Display help |
| `--version` | | Print version number |
| `--print-logs` | | Print logs to stderr |
+| `--prompt` | `-p` | Prompt to use |
+| `--model` | `-m` | Model to use in the form of provider/model |
diff --git a/packages/web/src/content/docs/docs/share.mdx b/packages/web/src/content/docs/docs/share.mdx
new file mode 100644
index 000000000..0d52d0fce
--- /dev/null
+++ b/packages/web/src/content/docs/docs/share.mdx
@@ -0,0 +1,103 @@
+---
+title: Share
+description: Share your opencode conversations.
+---
+
+opencode's share feature allows you to create public links to your opencode conversations, so you can collaborate with teammates or get help from others.
+
+:::note
+Shared conversations are publicly accessible to anyone with the link.
+:::
+
+---
+
+## How it works
+
+When you share a conversation, opencode:
+
+1. Creates a unique public URL for your session
+2. Syncs your conversation history to our servers
+3. Makes the conversation accessible via the shareable link
+
+---
+
+## Sharing
+
+You can manually share a conversation or enable automatic sharing for all new conversations.
+
+---
+
+### Manual
+
+Use the `/share` command in any conversation to create a shareable link:
+
+```
+/share
+```
+
+This will generate a unique URL that'll be copied to your clipboard.
+
+---
+
+### Autoshare
+
+You can enable automatic sharing for all new conversations through the `autoshare` option in your [config file](/docs/config).
+
+```json title="opencode.json"
+{
+ "$schema": "https://opencode.ai/config.json",
+ "autoshare": true
+}
+```
+
+By default, `autoshare` is disabled.
+
+---
+
+## Unsharing
+
+To stop sharing a conversation and remove it from public access:
+
+```
+/unshare
+```
+
+This will remove the share link and delete the data related to the conversation.
+
+---
+
+## Privacy
+
+There are a few things to keep in mind when sharing a conversation.
+
+---
+
+### Data retention
+
+Shared conversations remain accessible until you explicitly unshare them. This
+includes:
+
+- Full conversation history
+- All messages and responses
+- Session metadata
+
+---
+
+### Recommendations
+
+- Only share conversations that don't contain sensitive information
+- Review conversation content before sharing
+- Unshare conversations when collaboration is complete
+- Avoid sharing conversations with proprietary code or confidential data
+
+---
+
+## For enterprises
+
+For enterprise deployments, the share feature can be:
+
+- **Self-hosted** on your own infrastructure
+- **Restricted** to authenticated users only
+- **Disabled** entirely for security compliance
+
+[Learn more](/docs/enterprise) about using opencode in your organization.
diff --git a/packages/web/src/content/docs/docs/troubleshooting.mdx b/packages/web/src/content/docs/docs/troubleshooting.mdx
index 3ab6144ae..1fcd53fd8 100644
--- a/packages/web/src/content/docs/docs/troubleshooting.mdx
+++ b/packages/web/src/content/docs/docs/troubleshooting.mdx
@@ -70,12 +70,16 @@ Here are some common issues and how to resolve them.
2. Try running with `--print-logs` to see output in the terminal
3. Ensure you have the latest version with `opencode upgrade`
+---
+
### Authentication issues
1. Try re-authenticating with `opencode auth login <provider>`
2. Check that your API keys are valid
3. Ensure your network allows connections to the provider's API
+---
+
### Model not available
1. Check that you've authenticated with the provider