Skip to content

Spinbox for VS Code

Open your Spinbox workspaces in VS Code over Remote-SSH: list them, start and stop them, and open one in a new window, without leaving the editor.

Requirements

  • Microsoft VS Code 1.146 or newer.
  • Microsoft's Remote-SSH, ms-vscode-remote.remote-ssh. When it is not installed, Spinbox offers to install it.
  • A Spinbox account, with an SSH key of this machine added to it. If none is, Spinbox says so and offers to add one.

The extension carries the spin CLI it needs, for Linux and macOS on x64 and arm64: there is nothing else to install.

Spinbox's own connection

With Spinbox Remote (spin-stack.spinbox-remote) installed and allowed VS Code's proposed API, Spinbox opens a workspace as vscode-remote://spin+<workspace>/... instead of over Remote-SSH: the connection is Spinbox's, so a workspace that does not open says why, in VS Code, with what to do. Its server comes from your installation, never a download.

  1. Install it with spin vscode install. The Visual Studio Marketplace does not carry an extension that uses a proposed API.

  2. VS Code lets a third-party extension use a proposed API only when argv.json names it. Run Preferences: Configure Runtime Arguments, add this line inside the object it opens, and restart VS Code:

    "enable-proposed-api": ["spin-stack.spinbox-remote"]

Spinbox checks for it on every open: until the resolver activates, workspaces open over Remote-SSH, and Spinbox says once what is missing.

Getting started

  1. Install Spinbox from the Extensions view.
  2. Open Spinbox Workspaces in the Explorer and select Sign In, or run Spinbox: Sign In from the Command Palette. Spinbox then shows in the Accounts menu.
  3. Select a workspace's Open Workspace action. A stopped workspace is started first; it opens in a new window, through Spinbox's own connection where it is enabled (above), otherwise over Remote-SSH.

Features

  • Spinbox Workspaces in the Explorer: every workspace with its state, and actions to open, start, stop and refresh.
  • Commands: Open Workspace, Start Workspace, Stop Workspace, Refresh Workspaces, Sign In and Sign Out, under Spinbox in the Command Palette.
  • Links: vscode://spin-stack.spinbox/open?workspace=<id> opens a workspace from a browser, and &path=<absolute path> a folder inside it.
  • Reconnects that start the workspace: a window reopening a workspace over Remote-SSH, by a reload or from the recent list, has Spinbox start it and attach your VS Code's server first; a refusal is shown with what fixes it, and the window leaves the remote instead of Remote-SSH failing on its own.
  • Errors you can act on: an outdated CLI, a missing SSH key or no room for a workspace each say what fixes it, with a button for it where there is one.

Settings

Setting Default What
spinbox.cliPath empty The spin CLI to run. Empty runs the one the extension carries.
spinbox.telemetry true Join each operation to the trace of the spin command it runs. Off, the CLI still traces its own commands unless its profile sets telemetry: false.

Contributing

How to build, test and release the extension is in CONTRIBUTING.md.

License

Apache-2.0

Releases

Packages

Used by

Contributors

Languages