Devbox Guide

Getting Started¶

This project uses devbox to manage its development environment.

Install devbox:

curl -fsSL https://get.jetpack.io/devbox | bash

Start the devbox shell:

devbox shell

Run a script in the devbox environment:

devbox run <script>

Scripts¶

Scripts are custom commands that can be run using this project's environment. This project has the following scripts:

• devbox-update
• devbox-upgrade
• docs-build
• docs-format
• docs-lint
• docs-serve
• help
• py-format
• py-lint
• reuse
• test
• uv-lock
• uv-sync
• uv-venv

Environment¶

DEVBOX_COREPACK_ENABLED="0"
LC_ALL="C.UTF-8"
OPENSPEC_TELEMETRY="0"
PATH="${PWD}/.venv/bin:${PWD}/node_modules/.bin:${PWD}/scripts:${PATH}"

Shell Init Hook¶

The Shell Init Hook is a script that runs whenever the devbox environment is instantiated. It runs on devbox shell and on devbox run.

echo '1️⃣  INITIATE UV INSTALLATION... 🪄' && make uv-venv
echo '2️⃣  DOWNLOAD UV DEPENDENCIES... 🪄' && make uv-sync
echo '👋 WELCOME TO COMMITIZEN-SPDX-CHANGELOG! 👷'

Packages¶

• direnv@2
• gh@2
• glow@2
• nodejs-slim@24
• opencode@1
• openspec@1
• prek@0
• python@3.14
• ripgrep@15
• shellcheck@0
• shfmt@3
• uv@0

Script Details¶

devbox run devbox-update¶

make devbox-update

devbox run devbox-upgrade¶

make devbox-upgrade

devbox run docs-build¶

make docs-build

devbox run docs-format¶

make docs-format

devbox run docs-lint¶

make docs-lint

devbox run docs-serve¶

make docs-serve

devbox run help¶

make help

devbox run py-format¶

make py-format

devbox run py-lint¶

make py-lint

devbox run reuse¶

make reuse

devbox run test¶

make test

devbox run uv-lock¶

make uv-lock

devbox run uv-sync¶

make uv-sync

devbox run uv-venv¶

make uv-venv