Skip to content

Latest commit

 

History

History
 
 

vscode-extension

README.md

devbox VSCode Extension

This is the official VSCode extension for devbox open source project by jetpack.io

Features

Auto Shell on a devbox project

When VScode Terminal is opened on a devbox project, this extension detects devbox.json and runs devbox shell so terminal is automatically in devbox shell environment. Can be turned off in settings.

Run devbox commands from command palette

cmd/ctrl + shift + p opens vscode's command palette. Typing devbox filters all available commands devbox extension can run. Those commands are:

  • Init: Creates a devbox.json file
  • Add: adds a package to devbox.json
  • Remove: Removes a package from devbox.json
  • Shell: Opens a terminal and runs devbox shell
  • Run: Runs a script from devbox.json if specified
  • Generate DevContainer files: Generates devcontainer.json & Dockerfile inside .devcontainers directory. This allows for running vscode in a container or Github Codespaces.
  • Generate a Dockerfile from devbox.json: Generates a Dockerfile a project's root directory. This allows for running the devbox project in a container.

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.