mirror of
https://github.com/aljazceru/opencode.git
synced 2025-12-22 18:24:21 +01:00
docs: share doc
This commit is contained in:
@@ -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 |
|
||||
|
||||
103
packages/web/src/content/docs/docs/share.mdx
Normal file
103
packages/web/src/content/docs/docs/share.mdx
Normal file
@@ -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.
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user