# spin vscode

**Spinbox is experimental: APIs change and data may be lost.** What is built and what proves it is on [Status](https://docs.spinbox.dev/reference/status.md); what Spinbox does not do is on [Limitations](https://docs.spinbox.dev/overview/limitations.md).

> spin vscode: The Spinbox extension for VS Code.

<!-- Generated by tools/refgen from spin:cmd/cli. Edit the source, not this file. -->

```
The Spinbox extension for VS Code

Usage:
  spin vscode [flags]
  spin vscode [command]

Available Commands:
  install     Install the Spinbox extension that carries this CLI's release, and Spinbox Remote, into VS Code

Flags:
  -h, --help[=true|false]   help for vscode

Global Flags:
      --config string        config file (default is $HOME/.spin/config.yaml)
  -o, --output string        text for a person, or json: one document of what the API answered, and no prose (default "text")
      --profile string       named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
      --traceparent string   the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false

Use "spin vscode [command] --help" for more information about a command.
```

### spin vscode install

```
Install the Spinbox extension (spin-stack.spinbox) into VS Code, from the release of
spin-stack/vscode-spinbox whose VSIXs carry this CLI's release, pulled anonymously from its
public package ghcr.io/spin-stack/vscode-spinbox-release (tag spin-<this release>), and beside
it Spinbox Remote (spin-stack.spinbox-remote), which opens the spin+<workspace> remote it opens
workspaces through.

Spinbox Remote uses VS Code's proposed resolvers API, which the Marketplace refuses, so it is
downloaded from the spin-stack/open-remote-ssh release this CLI's release pins, and held to the
SHA-256 pinned with it. Both VSIXs are checked before either is given to the editor.

The extension runs a spin CLI it carries, and an installation serves a CLI of its own release
alone, so the extension installed is the one carrying this CLI's release - not the newest. Its
VSIX for this machine is downloaded, held to the SHA-256 the release's SHA256SUMS lists, and
SHA256SUMS to the keyless signature its publish workflow made at the release's tag; only then is
it given to '<editor> --install-extension', replacing any version the editor has.

A release of the extension is preferred to a pre-release. When none carries this CLI's release,
nothing is installed: the Marketplace's or Open VSX's extension may carry another release.

Examples:
  spin vscode install
  spin vscode install --editor code-insiders

Usage:
  spin vscode install [flags]

Flags:
      --editor string       The editor's command: code, code-insiders, codium, cursor (default "code")
  -h, --help[=true|false]   help for install

Global Flags:
      --config string        config file (default is $HOME/.spin/config.yaml)
  -o, --output string        text for a person, or json: one document of what the API answered, and no prose (default "text")
      --profile string       named profile to use; SPIN_PROFILE names it when this flag does not (default "default")
      --traceparent string   the W3C traceparent of the span this command is part of; its own span is sent to the installation unless the profile says telemetry: false
```
