Devbox Plugin

Configuration for a Devbox plugin specification

Type object
File match devbox-plugin.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/devbox-plugin/latest.json
Source https://raw.githubusercontent.com/jetify-com/devbox/main/.schema/devbox-plugin.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Defines fields and values for public devbox plugins

Properties

name string required

The name of the plugin.

version string required

The version of the plugin.

description string required

A short description of the plugin and how it works. This will automatically display when the user first installs the plugin, or runs devbox info

$schema string

The schema version of this plugin file.

packages string[] | object

Collection of packages to install

env object

List of additional environment variables to be set in the Devbox environment. These can be overridden by environment variables set in the user's devbox.json

create_files object

List of files to create in the user's project directory when the plugin is activated. The key points to the file path where the file will be created. The value points to the default file that should be copied to that location

shell object

Shell specific options and hooks for the plugin.

include string[]

List of additional plugins to activate within your devbox shell