Elyro for VS Code and Cursor
Elyro brings a clear, native project manager for Elyro Linux Workspaces into VS Code and Cursor. Edit on macOS, run in Linux, and keep the Elyro CLI as the single source of truth.
What you can do
- Manage every project in the current editor window from the Elyro Activity Bar.
- See whether each Linux Workspace is running, stopped, or ready to start.
- Start a Workspace, then open it in the current editor.
- Open an integrated Linux shell.
- Run Elyro Doctor and review every check in a focused native list.
- Stop a Workspace with an explicit confirmation that project files are preserved.
- Inspect the exact Elyro commands and diagnostics in the Elyro output channel.
The extension uses a native Tree View, Quick Pick, notifications, progress, integrated terminals, and one quiet status item that appears only while the active project's Workspace is running. It does not add a custom webview or a second Workspace control plane.
Requirements
- macOS on Apple Silicon or Intel
- Elyro 0.1.5 or newer available on
PATH
- VS Code 1.99 or newer, or a compatible Cursor version
- Docker Desktop or another Elyro-compatible local Docker runtime
If Elyro is installed at a custom location, set elyro.executablePath in VS Code machine settings.
Quick start
- Open a project folder in VS Code or Cursor.
- Open Elyro from the Activity Bar.
- Expand the project and choose Start and Open.
- Use Open Shell whenever you want a Linux terminal for the project.
Projects that have not started Elyro remain neutral: they do not add a warning or red status item. You can also run every action from the Command Palette by entering Elyro.
Commands
| Command |
Purpose |
Elyro: Open Workspace Menu |
Show the native action menu for the current project |
Elyro: Show Workspace Status |
Show project, Linux mount, state, and published ports |
Elyro: Start Workspace |
Start or reuse the Workspace without opening another window |
Elyro: Start and Open Workspace |
Start or reuse the Workspace and continue in the current editor family |
Elyro: Open Workspace |
Open a running Workspace in VS Code or Cursor |
Elyro: Open Workspace Shell |
Create an integrated terminal backed by elyro shell |
Elyro: Run Doctor |
Show Elyro system, project, Workspace, and editor checks |
Elyro: Stop Workspace |
Preview and confirm removal of managed runtime state |
Elyro: Refresh Workspace Status |
Refresh the status bar without background polling |
Elyro: Show Output |
Open command and diagnostic output |
Safety and privacy
- Workspace-changing commands require VS Code Workspace Trust.
- Stop always requires explicit confirmation.
- Elyro is invoked with direct arguments; the extension does not construct shell command strings.
- The extension does not call Docker or SSH directly and does not read Elyro's internal registry.
- The extension has no telemetry, account, hosted service, or network API.
Troubleshooting
Run Elyro: Run Doctor first. If a command fails, choose Show Output from the error notification to see the Elyro diagnostic stream.
If the sidebar offers Get Elyro, verify the host installation:
elyro version --json
elyro doctor --json
For product behavior and CLI documentation, see the Elyro repository. For extension issues, use the elyro-vscode issue tracker.
Development
npm ci
npm run check
npm run test:integration
npm run package
npm run package:verify
The generated VSIX is written to artifacts/elyro-<version>.vsix and is intentionally excluded from Git.
License
Apache-2.0
