https://github.com/hexedtech/codemp-vscode
VSCode codemp plugin -- code multiplexer
https://github.com/hexedtech/codemp-vscode
codemp collaborative vscode
Last synced: 2 months ago
JSON representation
VSCode codemp plugin -- code multiplexer
- Host: GitHub
- URL: https://github.com/hexedtech/codemp-vscode
- Owner: hexedtech
- License: gpl-3.0
- Created: 2024-08-03T12:46:29.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2025-02-17T21:07:22.000Z (8 months ago)
- Last Synced: 2025-04-13T01:55:23.319Z (6 months ago)
- Topics: codemp, collaborative, vscode
- Language: TypeScript
- Homepage: https://code.mp
- Size: 430 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://code.mp)
[](https://github.com/hexedtech/codemp/actions)
[](https://marketplace.visualstudio.com/items?itemName=hexedtech.codemp)
[](https://marketplace.visualstudio.com/items?itemName=hexedtech.codemp)
[](https://gitter.im/hexedtech/codemp)
> `codemp` is a **collaborative** text editing solution to work remotely.
It seamlessly integrates in your editor providing remote cursors and instant text synchronization,
as well as a remote virtual workspace for you and your team.
# codemp-vscode
This is the reference codemp [vscode](https://code.visualstudio.com/) plugin maintained by [hexedtech](https://hexed.technology)
# installation
**Install from [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=hexedtech.codemp): `ext install hexedtech.codemp`**
Automatically built artifacts are available for download (to logged-in GitHub users) under [our Workflows page](https://github.com/hexedtech/codemp-vscode/actions/workflows/publish.yml).
> [!IMPORTANT]
> Remember to configure your credentials after installing!
To connect to the main `code.mp` server, you [will need an account](https://code.mp/signup).
# usage
To use `codemp`, you should first join a workspace. From inside, it's possible to share local files or fetch remote files, always keeping them in sync.
> [!TIP]
> Your current workspace directory is used as root for `codemp` files, which are relative paths.
Most actions can be performed from the `codemp` sidebar with contextual buttons.
## commands
| command | description |
| --- | --- |
| `codemp.connect ` | connect to remote codemp server using configured credentials |
once connected, more commands become available:
| command | description |
| --- | --- |
| `codemp.join ` | will join requested workspace; starts processing cursors and users |
| `codemp.createWorkspace ` | will create a new workspace with given name |
| `codemp.listWorkspaces` | list all workspaces available to join |
| `codemp.activeWorkspaces` | list all workspaces currently active |
| `codemp.inviteToWorkspace ` | invite a remote user to a workspace you own |
| `codemp.deleteWorkspace` | delete a workspace |
after a workspace is joined, more commands become available:
| command | description |
| --- | --- |
| `codemp.leaveWorkspace ` | leave a currently active workspace |
| `codemp.attach ` | will fetch remote buffer and keep it in sync |
| `codemp.share` | will share current buffer and keep it in sync |
| `codemp.createBuffer ` | will create a new empty buffer in workspace |
| `codemp.listBuffers` | will list all available buffers in workspace |
| `codemp.detach ` | will detach from remote buffer |
| `codemp.deleteBuffer ` | will delete remote buffer |
| `codemp.sync` | forces resynchronization of current buffer |
| `codemp.jump` | jump to user's last cursor position |
some commands for the Tree View are also provided:
| command | description |
| --- | --- |
| `codemp.refresh` | redraws tree view |
| `codemp.focus` | focuses tree view |