Skip to content
Sign in

vscode

v0.2.0

VS Code as an iii worker — vscode::* functions run the VS Code Server through the code CLI per workspace, and a Console page embeds the Workbench for the working directory.

license: Apache-2.0developmenteditoridevscodeworkbench

Install

bash
iii trigger compose::add worker=vscode@0.2.0

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Functions6

vscode::delete

Function

Delete a VS Code Workbench instance and optionally its isolated profile.

Request
  • delete_profileboolean
  • idstringrequired
Response
  • deletedbooleanrequired

vscode::instances::list

Function

List the VS Code Workbench processes this worker owns.

Request
Empty object
Response
  • instancesobject[]required
    • exit_codeinteger
    • hoststring
    • idstring
    • namestring
    • pidinteger
    • portinteger
    • started_atstring
    • statusstringenum starting, running, stopped, failed
    • workspacestring

vscode::on-config-change

Function

Internal: reload the vscode configuration when it changes.

Request
Empty object
Response
valuenull

vscode::start

Function

Start (or reuse) a VS Code Workbench for an absolute workspace directory.

Request
  • idstring
  • namestring
  • workspacestringrequired
Response
  • exit_codeinteger
  • hoststringrequired
  • idstringrequired
  • namestring
  • pidinteger
  • portintegerrequired
  • started_atstring
  • statusstringrequiredenum starting, running, stopped, failed
  • workspacestringrequired

vscode::stop

Function

Stop a VS Code Workbench process group.

Request
  • idstringrequired
Response
  • exit_codeinteger
  • hoststring
  • idstringrequired
  • namestring
  • pidinteger
  • portinteger
  • started_atstring
  • statusstringrequiredenum starting, running, stopped, failed
  • workspacestring

vscode::ui-content

Function

Serve the injectable VS Code Console page assets.

Request
  • pathstringrequired
Response
  • contentstringrequired
  • content_typestringrequired

Search the registry

Find workers, kits and executables, or jump to a page.