From 5dc7d17d16666d902b017d5600e7d4ffab469390 Mon Sep 17 00:00:00 2001 From: Ben Potter Date: Wed, 15 Sep 2021 00:13:42 -0500 Subject: [PATCH] add CodeTogether docs --- docs/collaboration.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/collaboration.md b/docs/collaboration.md index d1235ec0..0a7cc235 100644 --- a/docs/collaboration.md +++ b/docs/collaboration.md @@ -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 +- shared 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 + ``` + + Or you could 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 start collaborating.