[ { "path": ".envrc", "content": "#!/usr/bin/env bash\n\n# Automatically sets up your devbox environment whenever you cd into this\n# directory via our direnv integration:\n\neval \"$(devbox generate direnv --print-envrc)\"\n\n# check out https://www.jetify.com/docs/devbox/ide_configuration/direnv/\n# for more details\n" }, { "path": ".gitattributes", "content": "*.go diff=golang\n*.sh diff=bash\n*.md diff=markdown\n*.py diff=python\n*.sql diff=sql\n\ndevbox.json linguist-language=json5\n\ngo.sum -diff linguist-generated\n" }, { "path": ".github/ISSUE_TEMPLATE/01-bug.yaml", "content": "name: Bug Report\ndescription: File a bug report\nlabels:\n - bug\n - triage\nbody:\n - type: textarea\n id: description\n attributes:\n label: What happened?\n description: >-\n Also include what you expected to happen and any other relevant details.\n validations:\n required: true\n - type: textarea\n id: repro\n attributes:\n label: Steps to reproduce\n description: >-\n What specific steps can we take to reproduce this issue?\n Including a script would be much appreciated!\n value: |\n 1.\n 2.\n 3.\n - type: dropdown\n id: commands\n attributes:\n label: Command\n description: What Devbox command were you running when the bug occurred?\n multiple: true\n options:\n - add\n - auth\n - create\n - generate\n - global\n - info\n - init\n - install\n - rm\n - run\n - search\n - services\n - shell\n - shellenv\n - update\n - version\n - type: textarea\n id: devbox-json\n attributes:\n label: devbox.json\n description: Please include a copy of your devbox.json file.\n render: \"jsonc\"\n - type: input\n id: devbox-version\n attributes:\n label: Devbox version\n description: \"Paste the output of `devbox version`.\"\n validations:\n required: true\n - type: input\n id: nix-version\n attributes:\n label: Nix version\n description: \"Paste the output of `nix --version`.\"\n - type: dropdown\n id: system\n attributes:\n label: What system does this bug occur on?\n options:\n - macOS (Intel)\n - macOS (Apple Silicon)\n - Linux (x86-64)\n - Linux (ARM64)\n - Other (please include in the description above)\n validations:\n required: true\n - type: textarea\n id: logs\n attributes:\n label: Debug logs\n description: >-\n If possible, reproduce the bug with the `DEVBOX_DEBUG=1` environment\n variable set and paste any output here.\n For example: `DEVBOX_DEBUG=1 devbox run -- mycrash.sh`.\n" }, { "path": ".github/ISSUE_TEMPLATE/02-feature.yaml", "content": "name: Feature Request\ndescription: Suggest an idea or new feature\nlabels:\n - feature\n - triage\nbody:\n - type: textarea\n id: problem\n attributes:\n label: What problem are you trying to solve?\n description: >-\n Describe the problem you're trying to solve with this feature.\n placeholder: I'm always frustrated when...\n validations:\n required: true\n - type: textarea\n id: solution\n attributes:\n label: What solution would you like?\n description: >-\n Describe the feature you would like to see implemented and explain how\n it would address the problem you described above.\n validations:\n required: true\n - type: textarea\n id: alternatives\n attributes:\n label: Alternatives you've considered\n description: >-\n Describe any alternative solutions or features you've considered. If you\n know of any similar features requested before, please include links to\n them.\n" }, { "path": ".github/ISSUE_TEMPLATE/03-package-bug.yaml", "content": "name: Package Issue\ndescription: Report a problem with an existing package on either Devbox or Nixhub\nlabels:\n - package\n - bug\n - triage\nbody:\n - type: input\n id: name\n attributes:\n label: Package name\n placeholder: go@1.21.6, python@3.10.13, etc.\n validations:\n required: true\n - type: textarea\n id: solution\n attributes:\n label: What changes are you requesting?\n description: >-\n Describe what's going wrong or what changes you'd like to see to the\n package.\n validations:\n required: true\n - type: input\n id: link\n attributes:\n label: Nixhub link\n placeholder: https://www.nixhub.io/packages/go\n" }, { "path": ".github/ISSUE_TEMPLATE/04-package-request.yaml", "content": "name: Package Request\ndescription: Request a new package to be added to Devbox and Nixhub\nlabels:\n - package\n - triage\nbody:\n - type: input\n id: name\n attributes:\n label: Package name\n description: What name are you requesting for the new package?\n validations:\n required: true\n - type: input\n id: nixpkgs\n attributes:\n label: Nix package link\n description: >-\n Are you able to find the package on https://search.nixos.org/packages?\n If so, please include a link to the search results. Otherwise, leave\n blank.\n - type: textarea\n id: software\n attributes:\n label: Software\n description: >-\n Provide a description of the software that should be added to the new\n package. Include any relevant links such as websites,\n GitHub repositories, etc.\n validations:\n required: true\n" }, { "path": ".github/pull_request_template.md", "content": "## Summary\n\n## How was it tested?\n\n## Community Contribution License\n\nAll community contributions in this pull request are licensed to the project\nmaintainers under the terms of the\n[Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0).\n\nBy creating this pull request, I represent that I have the right to license the\ncontributions to the project maintainers under the Apache 2 License as stated in\nthe\n[Community Contribution License](https://github.com/jetify-com/opensource/blob/main/CONTRIBUTING.md#community-contribution-license).\n" }, { "path": ".github/workflows/cache-upload.yml", "content": "name: cache-upload\n# Uploads devbox nix dependencies to cache\n\non:\n push:\n branches:\n - main\n workflow_dispatch:\n schedule:\n - cron: '30 8 * * *' # Run nightly at 8:30 UTC\n\npermissions:\n contents: read\n pull-requests: read\n\ndefaults:\n run:\n shell: bash\n\nenv:\n DEVBOX_API_TOKEN: ${{ secrets.DEVBOX_API_TOKEN }}\n DEVBOX_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n DEVBOX_DEBUG: 1\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n # I think this should be added to individual nix commands within devbox, but this is quick fix for now\n NIX_CONFIG: |\n access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}\n\njobs:\n upload-cache:\n strategy:\n matrix:\n os: [ubuntu-latest, macos-latest]\n runs-on: ${{ matrix.os }}\n timeout-minutes: 10\n steps:\n - uses: actions/checkout@v4\n\n # Build devbox from scratch because released devbox has a bug that prevents \n # DEVBOX_API_TOKEN use\n # we can remove this after 0.10.6 is out.\n - uses: actions/setup-go@v5\n with:\n go-version-file: ./go.mod\n - name: Build devbox\n run: | \n go build -o dist/devbox ./cmd/devbox\n sudo mv ./dist/devbox /usr/local/bin/\n\n # - name: Install devbox\n # uses: jetify-com/devbox-install-action@v0.14.0\n # with:\n # enable-cache: true\n\n # We upload twice, once before updating and once after. This shows a simple\n # method to cache the latest current and latest dependencies.\n # If we want read access to cache on multi-user nix installs (e.g. macos), \n # we need to call devbox cache configure. This is currently not working\n # as expected on CICD.\n - name: Upload cache\n run: |\n devbox cache upload\n devbox update\n devbox cache upload\n" }, { "path": ".github/workflows/cli-post-release.yml", "content": "name: cli-post-release\n# Finalize and announce the release once its been published on Github.\n\non:\n release:\n types: [released]\n\npermissions:\n contents: write\n pull-requests: read\n id-token: write # Needed for aws-actions/configure-aws-credentials@v1\n\njobs:\n publish:\n runs-on: ubuntu-latest\n environment: release\n steps:\n - name: Configure AWS Credentials\n uses: aws-actions/configure-aws-credentials@v1\n with:\n role-to-assume: ${{ secrets.AWS_ROLE }}\n aws-region: us-west-2\n - name: Update latest version in s3\n run: |\n tmp_file=$(mktemp)\n echo \"${{ github.ref_name }}\" > $tmp_file\n aws s3 cp $tmp_file s3://releases.jetpack.io/devbox/stable/version\n" }, { "path": ".github/workflows/cli-release.yml", "content": "name: cli-release\n# Releases the Devbox CLI\n\nconcurrency: cli-release\n\non:\n # Build/Release on demand\n workflow_dispatch:\n inputs:\n create_edge_release:\n description: \"Create edge release?\"\n required: false\n default: false\n type: boolean\n schedule:\n - cron: \"45 8 * * 4\" # Create edge weekly on Thursdays.\n push:\n tags:\n - \"*\" # Tags that trigger a new release version\n\npermissions:\n contents: write\n pull-requests: read\n id-token: write # Needed for aws-actions/configure-aws-credentials@v1\n\njobs:\n tests:\n uses: ./.github/workflows/cli-tests.yaml\n\n report-test-failures:\n runs-on: ubuntu-latest\n needs: tests\n if: failure() || cancelled()\n steps:\n - name: Notify jetpack.io slack of release status (only if tests fail)\n id: slack\n uses: slackapi/slack-github-action@v1.25.0\n with:\n payload: |\n {\n \"status\": \"test ${{ needs.tests.result }}\"\n }\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CLI_RELEASE_WEBHOOK_URL }}\n\n edge:\n runs-on: ubuntu-latest\n environment: release\n needs: tests\n if: ${{ inputs.create_edge_release || github.event.schedule }}\n steps:\n - name: Checkout source code\n uses: actions/checkout@v4\n with:\n fetch-depth: 0 # Needed by goreleaser to browse history.\n - name: Determine edge tag\n # This tag is semver and works with semver.Compare\n run: echo \"EDGE_TAG=0.0.0-edge.$(date +%Y-%m-%d)\" >> $GITHUB_ENV\n - name: Set edge tag\n id: tag_version\n uses: mathieudutour/github-tag-action@v6.1\n with:\n github_token: ${{ secrets.GITHUB_TOKEN }}\n custom_tag: ${{ env.EDGE_TAG }}\n tag_prefix: \"\"\n - name: Set up go\n uses: actions/setup-go@v5\n with:\n go-version-file: ./go.mod\n - name: Build snapshot with goreleaser\n uses: goreleaser/goreleaser-action@v6\n with:\n distribution: goreleaser\n version: latest\n args: release --clean --skip=announce,publish --snapshot\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n TELEMETRY_KEY: ${{ secrets.TELEMETRY_KEY }}\n SENTRY_DSN: ${{ secrets.SENTRY_DSN }}\n - name: Create Sentry release\n uses: getsentry/action-release@v1\n env:\n SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}\n SENTRY_ORG: ${{ vars.SENTRY_ORG }}\n SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}\n with:\n environment: development\n version: ${{ env.EDGE_TAG }}\n version_prefix: \"devbox@\"\n - name: Publish snapshot release to GitHub\n uses: softprops/action-gh-release@v1\n with:\n prerelease: true\n body: \"${{ env.EDGE_TAG }} edge release\"\n fail_on_unmatched_files: true\n tag_name: ${{ env.EDGE_TAG }}\n files: |\n dist/checksums.txt\n dist/*.tar.gz\n - name: Configure AWS Credentials\n uses: aws-actions/configure-aws-credentials@v1\n with:\n role-to-assume: ${{ secrets.AWS_ROLE }}\n aws-region: us-west-2\n - name: Update edge version in s3\n run: |\n tmp_file=$(mktemp)\n echo \"${{ env.EDGE_TAG }}\" > $tmp_file\n aws s3 cp $tmp_file s3://releases.jetpack.io/devbox/edge/version\n\n release:\n runs-on: ubuntu-latest\n environment: release\n needs: tests\n # Only release when there's a tag for the release.\n if: startsWith(github.ref, 'refs/tags/')\n steps:\n - name: Checkout source code\n uses: actions/checkout@v4\n with:\n fetch-depth: 0 # Needed by goreleaser to browse history.\n - name: Set up go\n uses: actions/setup-go@v5\n with:\n go-version-file: ./go.mod\n - name: Create Sentry release\n uses: getsentry/action-release@v1\n env:\n SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}\n SENTRY_ORG: ${{ vars.SENTRY_ORG }}\n SENTRY_PROJECT: ${{ vars.SENTRY_PROJECT }}\n with:\n environment: production\n version: ${{ github.ref }}\n version_prefix: \"devbox@\"\n - name: Release with goreleaser\n uses: goreleaser/goreleaser-action@v3\n with:\n distribution: goreleaser\n version: latest\n args: release --clean\n env:\n DISCORD_WEBHOOK_ID: ${{ secrets.DISCORD_WEBHOOK_ID }}\n DISCORD_WEBHOOK_TOKEN: ${{ secrets.DISCORD_WEBHOOK_TOKEN }}\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n TELEMETRY_KEY: ${{ secrets.TELEMETRY_KEY }}\n SENTRY_DSN: ${{ secrets.SENTRY_DSN }}\n - name: Notify jetpack.io slack of release status\n id: slack\n if: always()\n uses: slackapi/slack-github-action@v1.25.0\n with:\n payload: |\n {\n \"status\": \"release ${{ job.status }}\"\n }\n env:\n SLACK_WEBHOOK_URL: ${{ secrets.SLACK_CLI_RELEASE_WEBHOOK_URL }}\n" }, { "path": ".github/workflows/cli-tests.yaml", "content": "name: cli-tests\n# Runs the Devbox CLI tests\n\nconcurrency:\n group: ${{ github.ref }}\n cancel-in-progress: true\n\non:\n pull_request:\n push:\n branches:\n - main\n merge_group:\n branches:\n - main\n workflow_call:\n inputs:\n run-mac-tests:\n type: boolean\n workflow_dispatch:\n inputs:\n run-mac-tests:\n type: boolean\n description: Run tests on macOS\n example-debug:\n type: boolean\n description: Run example tests with DEVBOX_DEBUG=1 to increase verbosity\n schedule:\n - cron: '30 8 * * *' # Run nightly at 8:30 UTC\n\npermissions:\n contents: read\n pull-requests: read\n\ndefaults:\n run:\n # Explicitly setting the shell to bash runs commands with\n # `bash --noprofile --norc -eo pipefail` instead of `bash -e`.\n shell: bash\n\nenv:\n DEVBOX_DEBUG: 1\n DEVBOX_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n HOMEBREW_NO_ANALYTICS: 1\n HOMEBREW_NO_AUTO_UPDATE: 1\n HOMEBREW_NO_EMOJI: 1\n HOMEBREW_NO_ENV_HINTS: 1\n HOMEBREW_NO_INSTALL_CLEANUP: 1\n NIX_CONFIG: |\n access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}\n\njobs:\n build-devbox:\n strategy:\n matrix:\n os: [ubuntu-latest, macos-latest]\n runs-on: ${{ matrix.os }}\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-go@v5\n with:\n go-version-file: ./go.mod\n - name: Build devbox\n run: go build -o dist/devbox ./cmd/devbox\n - name: Upload devbox artifact\n uses: actions/upload-artifact@v4\n with:\n name: devbox-${{ runner.os }}-${{ runner.arch }}\n path: ./dist/devbox\n retention-days: 7\n\n typos:\n name: Spell Check with Typos\n if: github.ref != 'refs/heads/main'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - uses: crate-ci/typos@v1.16.26\n\n flake-test:\n name: Test Flake Build\n if: github.ref != 'refs/heads/main'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Install devbox\n uses: jetify-com/devbox-install-action@jl/migrate-installer\n with:\n enable-cache: true\n - name: Build flake\n run: |\n if ! devbox run build-flake; then\n echo \"::warning::If this fails, you probably have to run 'devbox run update-hash'\"\n exit 1\n fi\n - run: ./result/bin/devbox version\n\n golangci-lint:\n strategy:\n matrix:\n os: [ubuntu-latest, macos-latest]\n runs-on: ${{ matrix.os }}\n timeout-minutes: 10\n steps:\n - uses: actions/checkout@v4\n\n - name: Install devbox\n uses: jetify-com/devbox-install-action@jl/migrate-installer\n with:\n enable-cache: true\n\n - name: Mount golang cache\n uses: actions/cache@v4\n with:\n path: |\n ~/.cache/golangci-lint\n ~/.cache/go-build\n ~/go/pkg\n key: go-${{ runner.os }}-${{ hashFiles('go.sum') }}\n\n - run: devbox run lint\n\n test:\n needs: build-devbox\n strategy:\n matrix:\n is-main:\n - ${{ github.ref == 'refs/heads/main' && 'is-main' || 'not-main' }}\n os: [ubuntu-latest, macos-latest]\n # This is an optimization that runs tests twice, with and without\n # the devbox.json tests. We can require the other tests to complete before\n # merging, while keeping the others as an additional non-required signal\n run-project-tests: [\"project-tests-only\", \"project-tests-off\"]\n # Run tests on:\n # 1. the oldest supported nix version (Nixpkgs requires >= 2.18 as of 2026)\n # 2. nix 2.19.2: version before nix profile changes\n # 3. latest nix version (note, 2.20.1 introduced a new profile change)\n nix-version: [\"2.18.0\", \"2.19.2\", \"2.30.2\"]\n exclude:\n # Only runs tests on macos if explicitly requested, or on a schedule\n - os: \"${{ (inputs.run-mac-tests || github.event.schedule != '') && 'dummy' || 'macos-latest' }}\"\n\n\n runs-on: ${{ matrix.os }}\n timeout-minutes: 60\n env:\n # For devbox.json tests, we default to non-debug mode since the debug output is less useful than for unit testscripts.\n # But we allow overriding via inputs.example-debug\n DEVBOX_DEBUG: ${{ (matrix.run-project-tests == 'project-tests-off' || inputs.example-debug) && '1' || '0' }}\n DEVBOX_GOLANG_TEST_TIMEOUT: \"${{ (github.ref == 'refs/heads/main' || inputs.run-mac-tests) && '1h' || '30m' }}\"\n steps:\n - name: clear directories to reduce disk usage\n # https://github.com/actions/runner-images/issues/2840#issuecomment-1284059930\n run: |\n sudo rm -rf /usr/share/dotnet\n sudo rm -rf \"$AGENT_TOOLSDIRECTORY\"\n\n - uses: actions/checkout@v4\n - name: Mount golang cache\n uses: actions/cache@v4\n with:\n path: |\n ~/.cache/go-build\n ~/go/pkg\n key: go-devbox-tests-${{ runner.os }}-${{ hashFiles('go.sum') }}\n - name: Install additional shells (dash, zsh)\n run: |\n if [ \"$RUNNER_OS\" == \"Linux\" ]; then\n sudo apt-get update\n sudo apt-get install dash zsh\n elif [ \"$RUNNER_OS\" == \"macOS\" ]; then\n brew update\n brew install dash zsh\n fi\n - name: Install devbox\n uses: jetify-com/devbox-install-action@jl/migrate-installer\n with:\n enable-cache: true\n - name: Setup Nix GitHub authentication\n run: |\n # Setup github authentication to ensure Github's rate limits are not hit\n # For macOS, we need to configure the system-wide nix.conf because the Nix daemon\n # runs as a different user and doesn't read the user's ~/.config/nix/nix.conf\n if [ \"$RUNNER_OS\" == \"macOS\" ]; then\n echo \"Configuring system-wide Nix config for macOS daemon\"\n # Ensure /etc/nix directory exists\n if [ ! -d /etc/nix ]; then\n sudo mkdir -p /etc/nix\n fi\n # Check if file exists, create it if not\n if [ ! -f /etc/nix/nix.conf ]; then\n echo \"# Nix configuration\" | sudo tee /etc/nix/nix.conf > /dev/null\n fi\n echo \"access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}\" | sudo tee -a /etc/nix/nix.conf\n # Restart nix daemon to pick up the new configuration\n sudo launchctl stop org.nixos.nix-daemon || true\n sudo launchctl start org.nixos.nix-daemon || true\n sleep 2 # Give daemon time to restart\n fi\n # For Linux and as a backup for macOS, also configure user config\n mkdir -p ~/.config/nix\n echo \"access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}\" > ~/.config/nix/nix.conf\n - name: Run fast tests\n if: matrix.run-project-tests == 'project-tests-off'\n run: |\n echo \"::group::Nix version\"\n nix --version\n echo \"::endgroup::\"\n echo \"::group::Contents of /etc/nix/nix.conf\"\n cat /etc/nix/nix.conf || true\n echo \"::endgroup::\"\n echo \"::group::Resolved Nix config\"\n nix show-config --extra-experimental-features nix-command\n echo \"::endgroup::\"\n devbox run go test -v -timeout $DEVBOX_GOLANG_TEST_TIMEOUT ./...\n - name: Run project (slow) tests\n if: matrix.run-project-tests == 'project-tests-only'\n run: devbox run test-projects-only\n\n auto-nix-install: # ensure Devbox installs nix and works properly after installation.\n needs: build-devbox\n strategy:\n matrix:\n os: [ubuntu-latest, macos-latest]\n use-detsys: [true, false]\n runs-on: ${{ matrix.os }}\n steps:\n - uses: actions/checkout@v4\n - name: Download devbox\n uses: actions/download-artifact@v4\n with:\n name: devbox-${{ runner.os }}-${{ runner.arch }}\n - name: Add devbox to path\n run: |\n chmod +x ./devbox\n sudo mv ./devbox /usr/local/bin/\n - name: Install nix and devbox packages\n run: |\n export NIX_INSTALLER_NO_CHANNEL_ADD=1\n export DEVBOX_FEATURE_DETSYS_INSTALLER=${{ matrix.use-detsys }}\n\n # Setup github authentication BEFORE running devbox to ensure Github's rate limits are not hit.\n # Configure user config first (Nix installer will respect this)\n mkdir -p ~/.config/nix\n echo \"access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}\" > ~/.config/nix/nix.conf\n\n # Run devbox which will auto-install Nix if needed\n devbox run echo \"Installing packages...\"\n\n # After Nix is installed, configure system-wide config for the daemon on macOS\n if [ \"$RUNNER_OS\" == \"macOS\" ]; then\n echo \"Configuring system-wide Nix config for macOS daemon\"\n # Check if file exists, create directory if needed\n if [ ! -f /etc/nix/nix.conf ]; then\n sudo mkdir -p /etc/nix\n echo \"# Nix configuration\" | sudo tee /etc/nix/nix.conf > /dev/null\n fi\n echo \"access-tokens = github.com=${{ secrets.GITHUB_TOKEN }}\" | sudo tee -a /etc/nix/nix.conf\n # Restart nix daemon to pick up the new configuration\n sudo launchctl stop org.nixos.nix-daemon || true\n sudo launchctl start org.nixos.nix-daemon || true\n sleep 2 # Give daemon time to restart\n fi\n - name: Test removing package\n run: devbox rm go\n\n # Run a sanity test to make sure Devbox can install and remove packages with\n # the last few Nix releases.\n test-nix-versions:\n needs: build-devbox\n strategy:\n matrix:\n os: [ubuntu-latest, macos-latest]\n nix-version: [2.18.0, 2.19.2, 2.24.7, 2.30.2]\n runs-on: ${{ matrix.os }}\n steps:\n - uses: actions/checkout@v4\n - name: Download devbox\n uses: actions/download-artifact@v4\n with:\n name: devbox-${{ runner.os }}-${{ runner.arch }}\n - name: Add devbox to path\n run: |\n chmod +x ./devbox\n sudo mv ./devbox /usr/local/bin/\n - name: Install Nix\n uses: DeterminateSystems/nix-installer-action@v4\n with:\n logger: pretty\n extra-conf: experimental-features = ca-derivations fetch-closure\n nix-package-url: https://releases.nixos.org/nix/nix-${{ matrix.nix-version }}/nix-${{ matrix.nix-version }}-${{ runner.arch == 'X64' && 'x86_64' || 'aarch64' }}-${{ runner.os == 'macOS' && 'darwin' || 'linux' }}.tar.xz\n - name: Run devbox install, devbox run, devbox rm\n run: |\n echo \"::group::Nix version\"\n nix --version\n echo \"::endgroup::\"\n echo \"::group::Contents of /etc/nix/nix.conf\"\n cat /etc/nix/nix.conf || true\n echo \"::endgroup::\"\n echo \"::group::Resolved Nix config\"\n nix show-config --extra-experimental-features nix-command\n echo \"::endgroup::\"\n devbox install\n devbox run -- echo \"Hello from devbox!\"\n devbox rm go\n" }, { "path": ".github/workflows/debug.yaml", "content": "name: debug\n\non:\n workflow_dispatch:\n inputs:\n runner:\n description: \"Runner type to debug on\"\n required: true\n default: \"ubuntu-latest\"\n type: choice\n options:\n - macos-latest\n - ubuntu-latest\n\npermissions:\n contents: read\n\nenv:\n HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}\"\n HOMEBREW_NO_ANALYTICS: 1\n HOMEBREW_NO_AUTO_UPDATE: 1\n HOMEBREW_NO_EMOJI: 1\n HOMEBREW_NO_ENV_HINTS: 1\n HOMEBREW_NO_INSTALL_CLEANUP: 1\n\njobs:\n debug:\n runs-on: ${{ inputs.runner }}\n timeout-minutes: 10\n steps:\n - name: Get rate limits\n run: |\n curl https://api.github.com/rate_limit \\\n -H \"Accept: application/vnd.github+json\" \\\n -H \"Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}\" \\\n --show-error \\\n --silent \\\n | jq .\n - uses: actions/checkout@v4\n - uses: actions/setup-go@v5\n with:\n go-version-file: ./go.mod\n - run: |\n echo \"Starting a tmate session for 10 minutes.\"\n echo\n echo \"You can connect using the SSH command printed below to get an interactive shell\"\n echo \"on this GitHub Actions runner. Access is limited to the public SSH keys\"\n echo \"associated with your GitHub account.\"\n\n curl https://api.github.com/users/${{ github.actor }}/keys \\\n -H \"Accept: application/vnd.github+json\" \\\n --show-error \\\n --silent \\\n | jq .\n - uses: mxschmitt/action-tmate@v3\n with:\n limit-access-to-actor: true\n" }, { "path": ".github/workflows/docker-image-release.yml", "content": "name: docker-image-release\n\non:\n release:\n types:\n - published\n workflow_dispatch:\n inputs:\n tag:\n description: 'tag name'\n required: true\n default: ''\n type: string\n\njobs:\n docker-image-build-push:\n runs-on: ubuntu-latest\n steps:\n - name: Check out the repo\n uses: actions/checkout@v4\n - name: Set up QEMU\n uses: docker/setup-qemu-action@v2\n - name: Docker meta\n id: meta\n uses: docker/metadata-action@v5\n with:\n images: |\n jetpackio/devbox\n tags: |\n type=raw,value=${{ inputs.tag || github.ref_name }}\n flavor: |\n latest=false\n - name: Docker meta root\n id: metaroot\n uses: docker/metadata-action@v5\n with:\n images: |\n jetpackio/devbox-root-user\n tags: |\n type=raw,value=${{ inputs.tag || github.ref_name }}\n flavor: |\n latest=false\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@v2\n - name: Login to Docker Hub\n uses: docker/login-action@v2\n with:\n username: ${{ secrets.DOCKERHUB_USERNAME }}\n password: ${{ secrets.DOCKERHUB_PASSWORD }}\n - name: Build and push default\n uses: docker/build-push-action@v5\n with:\n context: ./internal/devbox/generate/tmpl/\n file: ./internal/devbox/generate/tmpl/DevboxImageDockerfile\n build-args: |\n DEVBOX_USE_VERSION=${{ inputs.tag || github.ref_name }}\n push: true\n platforms: linux/amd64,linux/arm64\n tags: ${{ steps.meta.outputs.tags }}\n - name: Build and push root user\n uses: docker/build-push-action@v5\n with:\n context: ./internal/devbox/generate/tmpl/\n file: ./internal/devbox/generate/tmpl/DevboxImageDockerfileRootUser\n build-args: |\n DEVBOX_USE_VERSION=${{ inputs.tag || github.ref_name }}\n push: true\n platforms: linux/amd64,linux/arm64\n tags: ${{ steps.metaroot.outputs.tags }}\n - name: Docker meta latest\n id: metalatest\n uses: docker/metadata-action@v5\n with:\n images: |\n jetpackio/devbox\n tags: |\n type=raw,value=latest\n flavor: |\n latest=true\n - name: Build and push latest\n uses: docker/build-push-action@v5\n with:\n context: ./internal/devbox/generate/tmpl/\n file: ./internal/devbox/generate/tmpl/DevboxImageDockerfile\n push: true\n platforms: linux/amd64,linux/arm64\n tags: ${{ steps.metalatest.outputs.tags }}\n - name: Docker meta root latest\n id: metarootlatest\n uses: docker/metadata-action@v5\n with:\n images: |\n jetpackio/devbox-root-user\n tags: |\n type=raw,value=latest\n flavor: |\n latest=true\n - name: Build and push root user latest\n uses: docker/build-push-action@v5\n with:\n context: ./internal/devbox/generate/tmpl/\n file: ./internal/devbox/generate/tmpl/DevboxImageDockerfileRootUser\n push: true\n platforms: linux/amd64,linux/arm64\n tags: ${{ steps.metarootlatest.outputs.tags }}\n" }, { "path": ".github/workflows/random-reviewer-assignment.yml", "content": "name: Random Reviewer Assignment\non:\n pull_request:\n types: [opened]\n\npermissions:\n contents: read\n pull-requests: write\n\nenv:\n GITHUB_TOKEN: ${{ secrets.GH_TOKEN_FOR_PR_ASSIGNMENT }}\n\njobs:\n assign-reviewer:\n runs-on: ubuntu-latest\n steps:\n - name: Randomly assign reviewer from team\n uses: actions/github-script@v6\n with:\n script: |\n const TRIAGE_USERNAME = 'Lagoja';\n const EXCLUDE_USERNAMES = ['jetpack-io-bot'];\n\n try {\n const authenticatedUser = await github.rest.users.getAuthenticated();\n \n const teamMembers = await github.rest.teams.listMembersInOrg({\n org: 'jetify-com',\n team_slug: 'eng'\n });\n \n const prAuthor = context.payload.pull_request.user.login.toLowerCase();\n const prAuthorId = context.payload.pull_request.user.id;\n const authenticatedUserLower = authenticatedUser.data.login.toLowerCase();\n\n // If the PR author is already a member of the team, we can skip random assignment\n const isPrAuthorInTeam = teamMembers.data.some(member => \n member.login.toLowerCase() === prAuthor && member.id === prAuthorId\n );\n\n if (isPrAuthorInTeam) {\n console.log(`PR author ${prAuthor} is already a team member, skipping random assignment.`);\n return;\n }\n \n // Get eligible reviewers (excluding PR author, authenticated user, and lagoja)\n const eligibleReviewers = teamMembers.data\n .filter(member => {\n const loginLower = member.login.toLowerCase();\n \n // Exclude authenticated user\n const isNotAuthenticatedUser = member.id !== authenticatedUser.data.id;\n const isNotTriage = loginLower !== TRIAGE_USERNAME.toLowerCase();\n const isNotExcludedUsername = !EXCLUDE_USERNAMES.includes(loginLower);\n\n return isNotAuthenticatedUser && isNotTriage && isNotExcludedUsername;\n })\n .map(member => member.login);\n \n console.log(`Eligible reviewers: ${eligibleReviewers.join(', ')}`);\n \n if (eligibleReviewers.length === 0) {\n console.log('No eligible reviewers found');\n return;\n }\n \n const randomReviewer = eligibleReviewers[Math.floor(Math.random() * eligibleReviewers.length)];\n const reviewers = [randomReviewer];\n\n // Only add TRIAGE_USERNAME if they're not the PR author and not the authenticated user\n if (prAuthor !== TRIAGE_USERNAME.toLowerCase() && \n authenticatedUserLower !== TRIAGE_USERNAME.toLowerCase()) {\n reviewers.push(TRIAGE_USERNAME);\n }\n \n console.log(`Final reviewers: ${reviewers.join(', ')}`);\n \n console.log(`Assigning reviewers: ${reviewers.join(', ')}`);\n \n await github.rest.pulls.requestReviewers({\n owner: context.repo.owner,\n repo: context.repo.repo,\n pull_number: context.payload.pull_request.number,\n reviewers\n });\n \n } catch (error) {\n console.error('Error assigning reviewer:', error);\n }\n" }, { "path": ".github/workflows/stale-issue-cleanup.yml", "content": "name: close-stale-issues\n# Marks issues and PRs as stale after 30 days, then closes them if marked stale for 5 days\non:\n schedule:\n - cron: '30 1 * * *'\n\njobs:\n stale:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/stale@v7\n with:\n stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove the `stale` label or add a comment, otherwise this issue will be closed in 5 days.'\n stale-pr-message: 'This PR is stale because it has been open 30 days with no activity. Remove the `stale` label or add a comment, otherwise this PR will be closed in 5 days.'\n exempt-issue-labels: 'future'\n exempt-pr-labels: 'awaiting-approval, work-in-progress'\n days-before-stale: 45\n days-before-close: 5\n operations: 100" }, { "path": ".github/workflows/vscode-ext-release.yaml", "content": "name: vscode-ext-release\n# Releases the Devbox VSCode extension to the marketplace\n\nconcurrency: vscode-ext-release\n\non: workflow_dispatch\n\njobs:\n build-publish:\n runs-on: ubuntu-latest\n environment: release\n steps:\n - name: Checkout\n uses: actions/checkout@v5\n - name: Setup NodeJS 24\n uses: actions/setup-node@v5\n with:\n node-version: 24\n - name: Install dependencies\n run: |\n npm install -g yarn\n npm install -g vsce\n npm install -g ovsx\n yarn install\n working-directory: vscode-extension\n - name: publish-vs\n run: |\n vsce publish -p ${{ secrets.VS_MARKETPLACE_TOKEN }} --yarn --skip-duplicate\n working-directory: vscode-extension\n - name: publish-ovsx\n run: |\n sed -i 's/\"publisher\": \"jetpack-io\"/\"publisher\": \"Jetify\"/g' package.json\n ovsx publish --pat ${{ secrets.OVSX_MARKETPLACE_TOKEN }} --yarn --skip-duplicate\n working-directory: vscode-extension\n" }, { "path": ".gitignore", "content": "# Global gitignore for the entire monorepo. Only add things here that truly\n# need to always be ignored regardless of project.\n#\n# If something is more specific to a particular project, add a gitignore in the\n# corresponding subdirectory.\n\n# MacOS filesystem\n.DS_Store\n\n# Editors\n.idea\n.vscode\n.zed\n\n# NodeJS\nnode_modules\n.yalc\ndist\n\n\n# Python\n*.pyc\n__pycache__/\n*.py[cod]\n*$py.class\n\n\n# Java\n*.class\n*.jar\n\n# devcontainer\n*.devcontainer\n\n# test specific files\n.test_tmp_*\n\n# deployment\n.vercel\n.yarn\n\n# Nix\nvendor/\nresult\n" }, { "path": ".golangci.yml", "content": "linters:\n disable-all: true\n enable:\n - dupl\n - errcheck\n - errorlint\n - gofmt\n - goimports\n - gosimple\n - govet\n - importas\n - ineffassign\n - misspell\n - nilerr\n - reassign\n - revive\n - staticcheck\n - stylecheck\n - typecheck\n - unconvert\n - unparam\n - unused\n - usestdlibvars\n - usetesting\n - varnamelen\n # - wrapcheck If we're going to use github.com/pkg/errors we should probably turn this on?\n # We'd like to have the following linter enabled, but it's broken for Go\n # 1.19 as of golangci-lint v1.48.0. Re-enable it when this issue is\n # fixed: https://github.com/golangci/golangci-lint/issues/2649\n # - structcheck\n\nlinters-settings:\n errorlint:\n errorf: false\n revive:\n rules: # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md\n - name: atomic\n - name: bare-return\n - name: bool-literal-in-expr\n - name: cognitive-complexity\n exclude:\n - \"**_test.go\"\n arguments:\n - 32 # TODO: gradually reduce it\n - name: datarace\n - name: duplicated-imports\n - name: early-return\n - name: error-return\n - name: error-strings\n - name: if-return\n - name: indent-error-flow\n - name: range-val-address\n - name: receiver-naming\n - name: time-naming\n - name: var-naming\n - name: unreachable-code\n varnamelen:\n max-distance: 10\n ignore-decls:\n - a []any\n - c echo.Context\n - const C\n - e error\n - e watch.Event\n - f *foo.Bar\n - f fmt.State\n - i int\n - id string\n - m map[string]any\n - m map[string]int\n - n int\n - ns string\n - ok bool\n - r *http.Request\n - r io.Reader\n - r *os.File\n - re *regexp.Regexp\n - sh *Shell\n - sh *shell\n - sh *shell.Shell\n - sh shell\n - T any\n - t testing.T\n - w http.ResponseWriter\n - w io.Writer\n - w *os.File\n wrapcheck:\n ignorePackageGlobs:\n - go.jetify.com/devbox/*\n misspell:\n ignore-words:\n - substituters\n" }, { "path": ".goreleaser.yaml", "content": "project_name: devbox\nbefore:\n hooks:\n - go mod tidy\nbuilds:\n - main: ./cmd/devbox/main.go\n binary: devbox\n flags:\n - -trimpath\n mod_timestamp: \"{{ .CommitTimestamp }}\" # For reproducible builds\n ldflags:\n - -s -w\n - -X go.jetify.com/devbox/internal/build.Version={{.Version}}\n - -X go.jetify.com/devbox/internal/build.Commit={{.Commit}}\n - -X go.jetify.com/devbox/internal/build.CommitDate={{.CommitDate}}\n - -X go.jetify.com/devbox/internal/build.SentryDSN={{ .Env.SENTRY_DSN }}\n - -X go.jetify.com/devbox/internal/build.TelemetryKey={{ .Env.TELEMETRY_KEY }}\n env:\n - CGO_ENABLED=0\n - GO111MODULE=on\n goos:\n - linux\n - darwin\n goarch:\n - 386\n - amd64\n - arm64\n - arm\n goarm:\n - 7\narchives:\n - files:\n - no-files-will-match-* # Glob that does not match to create archive with only binaries.\n name_template: '{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if eq .Arch \"arm\" }}v{{ .Arm }}l{{ end }}'\nsnapshot:\n name_template: \"{{ .Env.EDGE_TAG }}\"\nchecksum:\n name_template: \"checksums.txt\"\n algorithm: sha256\nrelease:\n prerelease: auto\n draft: true\n github:\n owner: jetify-com\n name: devbox\nannounce:\n discord:\n # Whether its enabled or not.\n # Defaults to false.\n enabled: false\n\n # Message template to use while publishing.\n # Defaults to `{{ .ProjectName }} {{ .Tag }} is out! Check it out at {{ .ReleaseURL }}`\n message_template: |\n **New Release: Devbox {{.Tag}}**\n We just released a version {{.Tag}} of `devbox`.\n\n Description:\n {{.TagBody}}\n\n Release: {{.ReleaseURL}}\n\n Updating:\n If you installed devbox via our recommended installer\n (`curl -fsSL https://get.jetpack.io/devbox | bash`) you will get the new version\n _automatically_, the next time you run `devbox`\n\n Thanks,\n jetpack.io\n\n # Set author of the embed.\n # Defaults to `GoReleaser`\n author: \"jetpack.io\"\n\n # Color code of the embed. You have to use decimal numeral system, not hexadecimal.\n # Defaults to `3888754` - the grey-ish from goreleaser\n color: \"2622553\" #This is the Jetpack Space color\n\n # URL to an image to use as the icon for the embed.\n # Defaults to `https://goreleaser.com/static/avatar.png`\n icon_url: \"\"\n" }, { "path": ".schema/devbox-plugin.schema.json", "content": "{\n \"$schema\": \"https://json-schema.org/draft-04/schema#\",\n \"$id\": \"https://github.com/jetify-com/devbox/plugins\",\n \"title\": \"Devbox Plugin Schema\",\n \"description\": \"Defines fields and values for public devbox plugins\",\n \"type\": \"object\",\n \"properties\": {\n \"$schema\": {\n \"description\": \"The schema version of this plugin file.\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of the plugin.\",\n \"type\": \"string\"\n },\n \"version\": {\n \"description\": \"The version of the plugin.\",\n \"type\": \"string\"\n },\n \"description\": {\n \"description\": \"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`\",\n \"type\": \"string\"\n },\n \"packages\": {\n \"description\": \"Collection of packages to install\",\n \"oneOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"description\": \"Name and version of each package in name@version format.\",\n \"type\": \"string\"\n }\n },\n {\n \"type\": \"object\",\n \"description\": \"Name of each package in {\\\"name\\\": {\\\"version\\\": \\\"1.2.3\\\"}} format.\",\n \"patternProperties\": {\n \".*\": {\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"description\": \"Version number of the specified package in {\\\"version\\\": \\\"1.2.3\\\"} format.\",\n \"properties\": {\n \"version\": {\n \"type\": \"string\",\n \"description\": \"Version of the package\"\n },\n \"platforms\": {\n \"type\": \"array\",\n \"description\": \"Names of platforms to install the package on. This package will be skipped for any platforms not on this list\",\n \"items\": {\n \"enum\": [\n \"i686-linux\",\n \"aarch64-linux\",\n \"aarch64-darwin\",\n \"x86_64-darwin\",\n \"x86_64-linux\",\n \"armv7l-linux\"\n ]\n }\n },\n \"excluded_platforms\": {\n \"type\": \"array\",\n \"description\": \"Names of platforms to exclude the package on\",\n \"items\": {\n \"enum\": [\n \"i686-linux\",\n \"aarch64-linux\",\n \"aarch64-darwin\",\n \"x86_64-darwin\",\n \"x86_64-linux\",\n \"armv7l-linux\"\n ]\n }\n },\n \"glibc_patch\": {\n \"type\": \"boolean\",\n \"description\": \"Whether to patch glibc to the latest available version for this package\"\n }\n }\n },\n {\n \"type\": \"string\",\n \"description\": \"Version of the package to install.\"\n }\n ]\n }\n }\n }\n ]\n },\n \"env\": {\n \"type\": \"object\",\n \"description\": \"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\",\n \"patternProperties\": {\n \".*\": {\n \"type\": \"string\",\n \"description\": \"Value of the environment variable.\"\n }\n }\n },\n \"create_files\": {\n \"type\": \"object\",\n \"description\": \"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\",\n \"patternProperties\": {\n \".*\": {\n \"type\": \"string\",\n \"description\": \"Contents of the file.\"\n }\n }\n },\n \"shell\": {\n \"type\": \"object\",\n \"description\": \"Shell specific options and hooks for the plugin.\",\n \"items\": {\n \"init_hook\": {\n \"type\": [\"array\", \"string\"],\n \"description\": \"Shell command to run right before initializing the user's shell, running a script, or starting a service\"\n },\n \"scripts\": {\n \"description\": \"List of command/script definitions to run with `devbox run `.\",\n \"type\": \"object\",\n \"patternProperties\": {\n \".*\": {\n \"description\": \"Alias name for the script.\",\n \"type\": [\"array\", \"string\"],\n \"items\": {\n \"type\": \"string\",\n \"description\": \"The script's shell commands.\"\n }\n }\n }\n }\n }\n },\n \"include\": {\n \"description\": \"List of additional plugins to activate within your devbox shell\",\n \"type\": \"array\",\n \"items\": {\n \"description\": \"Name of the plugin to activate.\",\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\"name\", \"version\", \"description\"]\n}\n" }, { "path": ".schema/devbox.schema.json", "content": "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"$id\": \"https://github.com/jetify-com/devbox\",\n \"title\": \"Devbox json definition\",\n \"description\": \"Defines fields and acceptable values of devbox.json\",\n \"type\": \"object\",\n \"properties\": {\n \"$schema\": {\n \"description\": \"The schema version of this devbox.json file.\",\n \"type\": \"string\"\n },\n \"name\": {\n \"description\": \"The name of the Devbox development environment.\",\n \"type\": \"string\"\n },\n \"description\": {\n \"description\": \"A description of the Devbox development environment.\",\n \"type\": \"string\"\n },\n \"packages\": {\n \"description\": \"Collection of packages to install\",\n \"oneOf\": [\n {\n \"type\": \"array\",\n \"items\": {\n \"description\": \"Name and version of each package in name@version format.\",\n \"type\": \"string\"\n }\n },\n {\n \"type\": \"object\",\n \"description\": \"Name of each package in {\\\"name\\\": {\\\"version\\\": \\\"1.2.3\\\"}} format.\",\n \"patternProperties\": {\n \".*\": {\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"description\": \"Version number of the specified package in {\\\"version\\\": \\\"1.2.3\\\"} format.\",\n \"properties\": {\n \"version\": {\n \"type\": \"string\",\n \"description\": \"Version of the package\"\n },\n \"platforms\": {\n \"type\": \"array\",\n \"description\": \"Names of platforms to install the package on. This package will be skipped for any platforms not on this list\",\n \"items\": {\n \"enum\": [\n \"i686-linux\",\n \"aarch64-linux\",\n \"aarch64-darwin\",\n \"x86_64-darwin\",\n \"x86_64-linux\",\n \"armv7l-linux\"\n ]\n }\n },\n \"excluded_platforms\": {\n \"type\": \"array\",\n \"description\": \"Names of platforms to exclude the package on\",\n \"items\": {\n \"enum\": [\n \"i686-linux\",\n \"aarch64-linux\",\n \"aarch64-darwin\",\n \"x86_64-darwin\",\n \"x86_64-linux\",\n \"armv7l-linux\"\n ]\n }\n },\n \"glibc_patch\": {\n \"type\": \"boolean\",\n \"description\": \"Whether to patch glibc to the latest available version for this package\"\n }\n }\n },\n {\n \"type\": \"string\",\n \"description\": \"Version of the package to install.\"\n }\n ]\n }\n }\n }\n ]\n },\n \"env\": {\n \"description\": \"List of additional environment variables to be set in the Devbox environment. Values containing $PATH or $PWD will be expanded. No other variable expansion or command substitution will occur.\",\n \"type\": \"object\",\n \"patternProperties\": {\n \".*\": {\n \"type\": \"string\",\n \"description\": \"Value of the environment variable.\"\n }\n }\n },\n \"shell\": {\n \"description\": \"Definitions of scripts and actions to take when in devbox shell.\",\n \"type\": \"object\",\n \"properties\": {\n \"init_hook\": {\n \"type\": [\n \"array\",\n \"string\"\n ],\n \"items\": {\n \"description\": \"List of shell commands/scripts to run right after devbox shell starts.\",\n \"type\": \"string\"\n }\n },\n \"scripts\": {\n \"description\": \"List of command/script definitions to run with `devbox run `.\",\n \"type\": \"object\",\n \"patternProperties\": {\n \".*\": {\n \"description\": \"Alias name for the script.\",\n \"type\": [\n \"array\",\n \"string\"\n ],\n \"items\": {\n \"type\": \"string\",\n \"description\": \"The script's shell commands.\"\n }\n }\n }\n }\n },\n \"additionalProperties\": false\n },\n \"include\": {\n \"description\": \"List of additional plugins to activate within your devbox shell\",\n \"type\": \"array\",\n \"items\": {\n \"description\": \"Name of the plugin to activate.\",\n \"type\": \"string\"\n }\n },\n \"env_from\": {\n \"type\": \"string\"\n },\n \"nixpkgs\": {\n \"type\": \"object\",\n \"properties\": {\n \"commit\": {\n \"type\": \"string\",\n \"description\": \"The commit hash of the nixpkgs repository to use\"\n }\n }\n }\n },\n \"additionalProperties\": false\n}\n" }, { "path": "CODE_OF_CONDUCT.md", "content": "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, caste, color, religion, or sexual\nidentity and orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n## Our Standards\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n- Demonstrating empathy and kindness toward other people\n- Being respectful of differing opinions, viewpoints, and experiences\n- Giving and gracefully accepting constructive feedback\n- Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n- Focusing on what is best not just for us as individuals, but for the overall\n community\n\nExamples of unacceptable behavior include:\n\n- The use of sexualized language or imagery, and sexual attention or advances of\n any kind\n- Trolling, insulting or derogatory comments, and personal or political attacks\n- Public or private harassment\n- Publishing others' private information, such as a physical or email address,\n without their explicit permission\n- Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n## Enforcement Responsibilities\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n## Scope\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement. Use the \"Report\nto repository admins\" functionality on GitHub to report.\n\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n## Enforcement Guidelines\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n### 1. Correction\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n### 2. Warning\n\n**Community Impact**: A violation through a single incident or series of\nactions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or permanent\nban.\n\n### 3. Temporary Ban\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n### 4. Permanent Ban\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within the\ncommunity.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.1, available at\n[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].\n\nCommunity Impact Guidelines were inspired by\n[Mozilla's code of conduct enforcement ladder][mozilla coc].\n\nFor answers to common questions about this code of conduct, see the FAQ at\n[https://www.contributor-covenant.org/faq][faq]. Translations are available at\n[https://www.contributor-covenant.org/translations][translations].\n\n[homepage]: https://www.contributor-covenant.org\n[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html\n[mozilla coc]: https://github.com/mozilla/diversity\n[faq]: https://www.contributor-covenant.org/faq\n[translations]: https://www.contributor-covenant.org/translations\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing\n\nWhen contributing to this repository, please describe the change you wish to\nmake via a related issue, or a pull request.\n\nPlease note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in\nall your interactions with the project.\n\n## Setting Up Development Environment\n\nBefore making any changes to the source code (documentation excluded) make sure\nyou have installed all the required tools.\n\n### With Devbox\n\nThe easiest way to develop Devbox is with Devbox!\n\n1. Install Devbox:\n\n curl -fsSL https://get.jetify.com/devbox | bash\n\n2. Clone this repository:\n\n git clone https://github.com/jetify-com/devbox.git go.jetify.com/devbox\n cd go.jetify.com/devbox\n\n3. Build the Devbox CLI. If you don't have Nix installed, Devbox will\n automatically install it for you before building:\n\n devbox run build\n\n4. Start a development shell using your build of Devbox:\n\n dist/devbox shell\n\nTip: you can also start VSCode from inside your Devbox shell with\n`devbox run code`.\n\n- If you encounter an error similar to: `line 3: command 'code' not found`, it\n means you do not have the Visual Studio Code \"Shell Command\" installed. Follow\n the official guide at https://code.visualstudio.com/docs/setup/mac. Please\n refer to the section under: \"Launching from the command line\".\n\n### Setting up the Environment Without Devbox\n\nIf you are unable to install or use Devbox, you can manually replicate the\nenvironment by following the steps below.\n\n1. Install Nix Package Manager. We recommend using the\n [Determinate Systems installer](https://github.com/DeterminateSystems/nix-installer):\n\n curl --proto '=https' --tlsv1.2 -sSf -L https://install.determinate.systems/nix | sh -s -- install\n\n Alternatively, you can also use\n [the official installer](https://nixos.org/download.html).\n\n2. Install [Go](https://go.dev/doc/install) (current version: 1.20)\n\n3. Clone this repository and build Devbox:\n\n git clone https://github.com/jetify-com/devbox.git go.jetify.com/devbox\n cd go.jetify.com/devbox\n go build ./cmd/devbox\n ./devbox run -- echo hello, world\n\n## Pull Request Process\n\n1. For new features or non-trivial changes, consider first filing an issue to\n discuss what changes you intend to make. This will let us help you with\n implementation details and to make sure we don't duplicate any work.\n2. Ensure any new feature or functionality includes tests to verify its\n correctness.\n3. Run `devbox run lint` and `devbox run test`.\n4. Run `go mod tidy` if you added any new dependencies.\n5. Submit your pull request and someone will take a look!\n\n### Style Guide\n\nWe don't expect you to read through a long style guide or be an expert in Go\nbefore contributing. When necessary, a reviewer will be happy to help out with\nany suggestions around code style when you submit your PR. Otherwise, the Devbox\ncodebase generally follows common Go idioms and patterns:\n\n- If you're unfamiliar with idiomatic Go,\n [Effective Go](https://go.dev/doc/effective_go) and the\n [Google Go Style Guide](https://google.github.io/styleguide/go) are good\n resources.\n- There's no strict commit message format, but a good practice is to start the\n subject with the name of the Go packages you add/modified. For example,\n `boxcli: update help for add command`.\n\n## Community Contribution License\n\nContributions made to this project must be made under the terms of the\n[Apache 2 License](https://www.apache.org/licenses/LICENSE-2.0).\n\n```\nBy making a contribution to this project, you certify that:\n\n a. The contribution was created in whole or in part by you and you have the right\n to submit it under the Apache 2 License; or\n\n b. The contribution is based upon previous work that, to the best of your\n knowledge, is covered under an appropriate open source license and you have the\n right under that license to submit that work with modifications, whether\n created in whole or in part by you, under the Apache 2 License; or\n\n c. The contribution was provided directly to you by some other person who\n certified (a), (b) or (c) and you have not modified it.\n\n d. You understand and agree that this project and the contribution are public\n and that a record of the contribution (including all personal information you\n submit with it, including your sign-off) is maintained indefinitely and may be\n redistributed consistent with this project or the open source license(s)\n involved.\n```\n" }, { "path": "LICENSE", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License." }, { "path": "NUSHELL.md", "content": "# Using Devbox with Nushell\n\nDevbox now supports [nushell](https://github.com/nushell/nushell) through the `--format` flag on the `shellenv` command.\n\n## Quick Start\n\n**Add this to `~/.config/nushell/env.nu`:**\n\n```nushell\ndevbox global shellenv --format nushell --preserve-path-stack -r\n | lines \n | parse \"$env.{name} = \\\"{value}\\\"\"\n | where name != null \n | transpose -r \n | into record \n | load-env\n```\n\nThis is equivalent to bash's `eval \"$(devbox global shellenv)\"` and runs on every fresh shell start.\n\n---\n\n## Global Configuration\n\nTo use devbox global packages with nushell, you need to load the environment similar to how bash/zsh use `eval \"$(devbox global shellenv)\"`.\n\n### Dynamic loading with `load-env` - eval equivalent\n\nAdd this to `~/.config/nushell/env.nu` to regenerate and load devbox environment fresh every time, just like bash's `eval`:\n\n```nushell\n# Load devbox global environment dynamically (equivalent to bash eval)\ndevbox global shellenv --format nushell --preserve-path-stack -r\n | lines \n | parse \"$env.{name} = \\\"{value}\\\"\"\n | where name != null \n | transpose -r \n | into record \n | load-env\n```\n\n- `--format nushell` - Output in nushell syntax\n- `--preserve-path-stack` - Maintain existing PATH order if devbox is already active\n- `-r` (recompute) - Always recompute the environment, prevents \"out of date\" warnings\n" }, { "path": "README.md", "content": "\n \n \n \"Devbox\n\n\n# Devbox\n\n### Instant, easy, and predictable development environments\n\n[![Join Discord](https://img.shields.io/discord/903306922852245526?color=7389D8&label=discord&logo=discord&logoColor=ffffff&cacheSeconds=1800)](https://discord.gg/jetify)\n![License: Apache 2.0](https://img.shields.io/github/license/jetify-com/devbox)\n[![version](https://img.shields.io/github/v/release/jetify-com/devbox?color=green&label=version&sort=semver)](https://github.com/jetify-com/devbox/releases)\n[![tests](https://github.com/jetify-com/devbox/actions/workflows/cli-post-release.yml/badge.svg)](https://github.com/jetify-com/devbox/actions/workflows/cli-release.yml?branch=main)\n[![Built with Devbox](https://www.jetify.com/img/devbox/shield_galaxy.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/)\n\n## What is it?\n\n[Devbox](https://www.jetify.com/devbox/) is a command-line tool that lets you\neasily create isolated shells for development. You start by defining the list of\npackages required by your development environment, and devbox uses that\ndefinition to create an isolated environment just for your application.\n\nIn practice, Devbox works similar to a package manager like `yarn` – except the\npackages it manages are at the operating-system level (the sort of thing you\nwould normally install with `brew` or `apt-get`). With Devbox, you can install\nover [400,000 package versions](https://www.nixhub.io) from the Nix Package\nRegistry\n\nDevbox was originally developed by [Jetify](https://www.jetify.com) and is\ninternally powered by `nix`.\n\n## Demo\n\nThe example below creates a development environment with `python 2.7` and\n`go 1.18`, even though those packages are not installed in the underlying\nmachine:\n\n![screen cast](https://user-images.githubusercontent.com/279789/186491771-6b910175-18ec-4c65-92b0-ed1a91bb15ed.svg)\n\n## Installing Devbox\n\nUse the following install script to get the latest version of Devbox:\n\n```sh\ncurl -fsSL https://get.jetify.com/devbox | bash\n```\n\nRead more on the\n[Devbox docs](https://www.jetify.com/devbox/docs/installing-devbox/).\n\n## Benefits\n\n### A consistent shell for everyone on the team\n\nDeclare the list of tools needed by your project via a `devbox.json` file and\nrun `devbox shell`. Everyone working on the project gets a shell environment\nwith the exact same version of those tools.\n\n### Try new tools without polluting your laptop\n\nDevelopment environments created by Devbox are isolated from everything else in\nyour laptop. Is there a tool you want to try without making a mess? Add it to a\nDevbox shell, and remove it when you don't want it anymore – all while keeping\nyour laptop pristine.\n\n### Don't sacrifice speed\n\nDevbox can create isolated environments right on your laptop, without an\nextra-layer of virtualization slowing your file system or every command. When\nyou're ready to ship, it'll turn it into an equivalent container – but not\nbefore.\n\n### Goodbye conflicting versions\n\nAre you working on multiple projects, all of which need different versions of\nthe same binary? Instead of attempting to install conflicting versions of the\nsame binary on your laptop, create an isolated environment for each project, and\nuse whatever version you want for each.\n\n### Take your environment with you\n\nDevbox's dev environments are _portable_. We make it possible to declare your\nenvironment exactly once, and use that single definition in several different\nways, including:\n\n- A local shell created through `devbox shell`\n- A devcontainer you can use with VSCode\n- A Dockerfile so you can build a production image with the exact same tools you\n used for development.\n- A remote development environment in the cloud that mirrors your local\n environment.\n\n## Quickstart: Fast, Deterministic Shell\n\nIn this quickstart we'll create a development shell with specific tools\ninstalled. These tools will only be available when using this Devbox shell,\nensuring we don't pollute your machine.\n\n1. Open a terminal in a new empty folder.\n\n2. Initialize Devbox:\n\n ```bash\n devbox init\n ```\n\n This creates a `devbox.json` file in the current directory. You should commit\n it to source control.\n\n3. Add command-line tools from Nix. For example, to add Python 3.10:\n\n ```bash\n devbox add python@3.10\n ```\n\n Search for more packages on [Nixhub.io](https://www.nixhub.io)\n\n4. Your `devbox.json` file keeps track of the packages you've added, it should\n now look like this:\n\n ```json\n {\n \"packages\": [\n \"python@3.10\"\n ]\n }\n ```\n\n5. Start a new shell that has these tools installed:\n\n ```bash\n devbox shell\n ```\n\n You can tell you're in a Devbox shell (and not your regular terminal) because\n the shell prompt changed.\n\n6. Use your favorite tools.\n\n In this example we installed Python 3.10, so let's use it.\n\n ```bash\n python --version\n ```\n\n7. Your regular tools are also available including environment variables and\n config settings.\n\n ```bash\n git config --get user.name\n ```\n\n8. To exit the Devbox shell and return to your regular shell:\n\n ```bash\n exit\n ```\n\nRead more on the\n[Devbox docs Quickstart](https://www.jetify.com/devbox/docs/quickstart/).\n\n## Additional commands\n\n`devbox help` - see all commands\n\nSee the\n[CLI Reference](https://www.jetify.com/devbox/docs/cli_reference/devbox/) for\nthe full list of commands.\n\n## Join our Developer Community\n\n- Chat with us by joining the [Jetify Discord Server](https://discord.gg/jetify)\n – we have a #devbox channel dedicated to this project.\n- File bug reports and feature requests using\n [Github Issues](https://github.com/jetify-com/devbox/issues)\n- Follow us on [Jetify's Twitter](https://twitter.com/jetify_com) for product\n updates\n\n## Contributing\n\nDevbox is an opensource project, so contributions are always welcome. Please read\n[our contributing guide](CONTRIBUTING.md) before submitting pull requests.\n\n[Devbox development readme](devbox.md)\n\n## Related Work\n\nThanks to [Nix](https://nixos.org/) for providing isolated shells.\n\n## License\n\nThis project is proudly open-source under the\n[Apache 2.0 License](https://github.com/jetify-com/devbox/blob/main/LICENSE)\n" }, { "path": "cmd/devbox/main.go", "content": "// Copyright 2024 Jetify Inc. and contributors. All rights reserved.\n// Use of this source code is governed by the license in the LICENSE file.\n\npackage main\n\nimport (\n\t\"go.jetify.com/devbox/internal/boxcli\"\n)\n\nfunc main() {\n\tboxcli.Main()\n}\n" }, { "path": "devbox.go", "content": "// Package devbox creates and configures Devbox development environments.\npackage devbox\n\nimport (\n\t\"context\"\n\t\"io\"\n\n\t\"go.jetify.com/devbox/internal/devbox\"\n\t\"go.jetify.com/devbox/internal/devbox/devopt\"\n)\n\n// Devbox is a Devbox development environment.\ntype Devbox struct {\n\tdx *devbox.Devbox\n}\n\n// Open loads a Devbox environment from a config file or directory.\nfunc Open(path string) (*Devbox, error) {\n\tdx, err := devbox.Open(&devopt.Opts{\n\t\tDir: path,\n\t\tStderr: io.Discard,\n\t})\n\tif err != nil {\n\t\treturn nil, err\n\t}\n\treturn &Devbox{dx: dx}, nil\n}\n\n// Install downloads and installs missing packages.\nfunc (d *Devbox) Install(ctx context.Context) error {\n\treturn d.dx.Install(ctx)\n}\n" }, { "path": "devbox.json", "content": "{\n \"name\": \"devbox\",\n \"description\": \"Instant, easy, and predictable development environments\",\n \"packages\": {\n \"fd\": \"latest\",\n \"git\": \"latest\",\n \"go\": \"latest\"\n },\n \"env\": {\n \"GOENV\": \"off\",\n \"PATH\": \"$PWD/dist/tools:$PATH:$PWD/dist\",\n // Disabling CGO is a workaround for a clang linker error in macos\n // This should be okay, because Devbox doesn't require CGO\n // https://github.com/NixOS/nixpkgs/issues/433688#issuecomment-3231557942\n \"CGO_ENABLED\": \"0\",\n },\n \"shell\": {\n \"init_hook\": [\n // Remove Go environment variables that might've been inherited from the\n // user's environment and could affect the build.\n \"test -z $FISH_VERSION && \\\\\",\n \"unset GO111MODULE GOARCH GOFLAGS GOMOD GOOS GOROOT GOTOOLCHAIN GOWORK || \\\\\",\n \"set --erase GO111MODULE GOARCH GOFLAGS GOMOD GOOS GOROOT GOTOOLCHAIN GOWORK\",\n \"GOBIN=$PWD/dist/tools go install tool\"\n ],\n \"scripts\": {\n // Build devbox for the current platform\n \"build\": \"go build -o dist/devbox ./cmd/devbox\",\n \"build-darwin-amd64\": \"GOOS=darwin GOARCH=amd64 go build -o dist/devbox-darwin-amd64 ./cmd/devbox\",\n \"build-darwin-arm64\": \"GOOS=darwin GOARCH=arm64 go build -o dist/devbox-darwin-arm64 ./cmd/devbox\",\n \"build-linux-amd64\": \"GOOS=linux GOARCH=amd64 go build -o dist/devbox-linux-amd64 ./cmd/devbox\",\n \"build-linux-arm64\": \"GOOS=linux GOARCH=arm64 go build -o dist/devbox-linux-arm64 ./cmd/devbox\",\n \"build-all\": [\n \"devbox run build-darwin-amd64\",\n \"devbox run build-darwin-arm64\",\n \"devbox run build-linux-amd64\",\n \"devbox run build-linux-arm64\"\n ],\n // Open VSCode\n \"code\": \"code .\",\n \"lint\": \"go tool golangci-lint run --timeout 5m && scripts/gofumpt.sh\",\n \"fmt\": \"scripts/gofumpt.sh\",\n \"test\": \"go test -race -cover ./...\",\n \"test-projects-only\": \"DEVBOX_RUN_PROJECT_TESTS=1 go test -v -timeout ${DEVBOX_GOLANG_TEST_TIMEOUT:-30m} ./... -run \\\"TestExamples|TestScriptsWithProjects\\\"\",\n \"update-examples\": \"devbox run build && go run testscripts/testrunner/updater/main.go\",\n // Updates the Flake's vendorHash: First run `go mod vendor` to vendor\n // the dependencies, then hash the vendor directory with Nix.\n // The hash is saved to the `vendor-hash` file, which is then\n // read into the Nix Flake.\n \"update-hash\": [\n // realpath to work-around nix hash not liking symlinks\n \"vendor=$(realpath $(mktemp -d))\",\n \"trap \\\"rm -rf $vendor\\\" EXIT\",\n \"go mod vendor -o $vendor\",\n \"nix hash path $vendor >vendor-hash\"\n ],\n \"build-flake\": \"nix build .\",\n \"tidy\": [\"go mod tidy\", \"devbox run update-hash\"],\n // docker-testscripts runs the testscripts with Docker to exercise\n // Linux-specific tests. It invokes the test binary directly, so any extra\n // test runner flags must have their \"-test.\" prefix.\n //\n // For example, to only run Python tests:\n //\n // devbox run docker-testscripts -test.run ^TestScripts$/python\n \"docker-testscripts\": [\n \"cd testscripts\",\n\n // The Dockerfile looks for a testscripts-$TARGETOS-$TARGETARCH binary\n // to run the tests. Pre-compiling a static test binary lets us avoid\n // polluting the container with a Go toolchain or shared libraries that\n // might interfere with linker tests.\n \"trap 'rm -f testscripts-linux-amd64 testscripts-linux-arm64' EXIT\",\n \"GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go test -c -o testscripts-linux-amd64\",\n \"GOOS=linux GOARCH=arm64 CGO_ENABLED=0 go test -c -o testscripts-linux-arm64\",\n \"image=$(docker build --quiet --tag devbox-testscripts-ubuntu:noble --platform linux/amd64 .)\",\n \"docker run --rm --mount type=volume,src=devbox-testscripts-amd64,dst=/nix --platform linux/amd64 -e DEVBOX_RUN_FAILING_TESTS -e DEVBOX_RUN_PROJECT_TESTS -e DEVBOX_DEBUG $image \\\"$@\\\"\"\n ]\n }\n }\n}\n" }, { "path": "devbox.md", "content": "\n\n# devbox\n\nInstant, easy, and predictable development environments\n\n## Getting Started\n\nThis project uses [devbox](https://github.com/jetify-com/devbox) to manage its\ndevelopment environment.\n\nInstall devbox:\n\n```sh\ncurl -fsSL https://get.jetify.com/devbox | bash\n```\n\nStart the devbox shell:\n\n```sh\ndevbox shell\n```\n\nRun a script in the devbox environment:\n\n```sh\ndevbox run