opencodespaces
v1.7.0
Published
CLI for OpenCodeSpaces - Connect your local IDE to cloud sessions
Downloads
665
Maintainers
Readme
OpenCodeSpaces CLI
Connect your local IDE (VSCode, JetBrains, Neovim, etc.) to OpenCodeSpaces cloud development sessions.
Features
- Bidirectional file sync - Changes sync in real-time between local and cloud
- Works with any IDE - VSCode, JetBrains, Neovim, Sublime, and more
- SSH tunneling - Secure WebSocket connection, no exposed ports required
- Interactive session selection - Easy session picker or direct ID usage
Prerequisites
Install Mutagen for file synchronization:
# macOS
brew install mutagen-io/mutagen/mutagen
# Linux/Windows
# Download from https://mutagen.io/documentation/introduction/installationInstallation
npm install -g opencodespacesQuick Start
# 1. Login to your OpenCodeSpaces server
opencodespaces login https://your-server.com
# 2. Start syncing (interactive mode)
opencodespaces sync
# 3. Open the local directory in your favorite IDECommands
Authentication
| Command | Description |
|---------|-------------|
| opencodespaces login [server] | Authenticate via browser OAuth |
| opencodespaces login [server] --save | Login and save server as default |
| opencodespaces logout | Remove stored credentials |
| opencodespaces whoami | Show current user and server |
Sessions
| Command | Description |
|---------|-------------|
| opencodespaces sessions | List available sessions |
Sync
| Command | Description |
|---------|-------------|
| opencodespaces sync | Interactive session selection and sync |
| opencodespaces sync start <id> [-d path] | Start syncing with a specific session |
| opencodespaces sync stop [id] | Stop syncing (all or specific session) |
| opencodespaces sync status | Show current sync status |
SSH
| Command | Description |
|---------|-------------|
| opencodespaces ssh <id> | Open SSH shell to session |
| opencodespaces ssh <id> --stdio | STDIO mode for ProxyCommand |
Excluded Files
By default, these patterns are excluded from sync:
node_modules/ .git/ .DS_Store *.log dist/ build/
coverage/ .next/ __pycache__/ venv/ .venv/ .turbo/ .cache/Run npm install separately on both local and remote environments.
Configuration
Configuration files are stored in ~/.opencodespaces/:
| File | Purpose |
|------|---------|
| config.json | Server URL, custom ignores |
| credentials.json | Auth token (auto-managed) |
| keys/ | Temporary SSH keys |
Documentation
For full documentation, see:
License
MIT
