Installation Methods
- With VS Code
- Standalone CLI
The CLI is included with VS Code installations. After installing VS Code, the If the command is not found, you may need to add it to your PATH:
code command should be available in your terminal.Verifying Installation
- Windows
- macOS
- Linux
The installer should add VS Code to your PATH automatically. If not:
- Open VS Code
- Press
Ctrl+Shift+Pto open the Command Palette - Type “shell command” and select Shell Command: Install ‘code’ command in PATH
Building from Source
For developers who want to build the CLI from source:Building from source requires Rust toolchain and additional dependencies.
Prerequisites
Windows OpenSSL Details
Windows OpenSSL Details
On Windows, OpenSSL is required for key exchange in tunnel forwarding. The CLI uses OpenSSL for cryptographic operations until all Chromium-based clients support ED25519 key exchange natively.Steps to install:
- Follow vcpkg setup instructions
- Add vcpkg directory to your PATH
- Run
vcpkg install openssl:x64-windows-static-md - Restart your terminal
- Run
cargo build
Post-Installation Setup
Setting Default Data Directory
The CLI stores its data in a default directory. You can customize this:Configuring Logging
Set up logging for debugging:Verifying Installation
Run these commands to verify your installation:Updating the CLI
Integrated CLI
When installed with VS Code, the CLI updates automatically when you update VS Code.Standalone CLI
For standalone installations, use the update command:The
update command is only available in standalone CLI installations.Troubleshooting
Command not found: code
Command not found: code
Solution:
- Verify VS Code is installed: Check if VS Code exists in your Applications/Program Files
- Add to PATH manually (see installation methods above)
- Restart your terminal after adding to PATH
- On macOS/Linux, make sure your shell profile is sourced:
source ~/.bashrcorsource ~/.zshrc
Build fails on Windows with OpenSSL error
Build fails on Windows with OpenSSL error
Solution:
- Ensure vcpkg is properly installed
- Verify OpenSSL package:
vcpkg list | grep openssl - Install the correct variant:
vcpkg install openssl:x64-windows-static-md - Restart your terminal and try building again
Permission denied errors on Linux/macOS
Permission denied errors on Linux/macOS
Solution:
- Make the binary executable:
chmod +x /path/to/code - Check directory permissions
- Don’t run with sudo unless necessary
CLI version mismatch with VS Code
CLI version mismatch with VS Code
Solution:
- Ensure you’re using the correct binary (check with
which code) - Update VS Code to the latest version
- Reinstall the shell command from VS Code’s Command Palette
Uninstallation
- With VS Code
- Standalone
The CLI is removed when you uninstall VS Code. You may also need to:
- Remove the PATH entry from your shell profile
- Delete CLI data directory:
~/.vscode-oss/clior~/.vscode/cli
Next Steps
Commands Reference
Explore all available CLI commands
Remote Tunnels
Set up remote access with tunnels
Configuration
Configure the CLI for your needs
CLI Overview
Learn more about CLI features