summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src
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 /packages/web/src
parent8e0a1d11672509aa30abf73fd9f82e219335e22e (diff)
downloadopencode-69cf1d7b7e00c93f2eedbb5ff2688578814c08b0.tar.gz
opencode-69cf1d7b7e00c93f2eedbb5ff2688578814c08b0.zip
docs: share doc
Diffstat (limited to 'packages/web/src')
-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
3 files changed, 109 insertions, 0 deletions
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