Skip to content

add CodeTogether docs #4165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 15, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,33 @@ SERVICE_URL=https://open-vsx.org/vscode/gallery \
### Sharing with Duckly

As `code-server` is based on VS Code, you can follow the steps described on Duckly's [Pair programming with VS Code](https://duckly.com/tools/vscode) page and skip the installation step.

## Code sharing with CodeTogether

[CodeTogether](https://www.codetogether.com/) is another service with cross-platform live collaborative features:

- Sharing ports,
- Sharing, read/write terminals,
- Joining via web browser or another IDE.

However, some of these are [paid options](https://www.codetogether.com/pricing/).

### Installing the CodeTogether extension

1. Install the CodeTogether extension from OpenVSX on `code-server`.

```sh
SERVICE_URL=https://open-vsx.org/vscode/gallery \
ITEM_URL=https://open-vsx.org/vscode/item \
code-server --install-extension genuitecllc.codetogether
```

2. CodeTogether requires VS Code's proposed API to run. Start code-server with the following flag:

```sh
code-server --enable-proposed-api genuitecllc.codetogether
```

Another option would be to add a value in code-server's [config file](https://coder.com/docs/code-server/v3.11.1/FAQ#how-does-the-config-file-work).

3. Refresh code-server and navigate to the CodeTogether icon in the sidebar to host or join a coding session.