Skip to main content

Projects

This page describes all commands available in the nestbox CLI for managing project configuration. Projects define the default context used for most CLI operations, such as deploying agents or managing compute instances.

Each project setting is stored locally and can be associated with a specific directory via a .nestboxrc file.

Set Active Project​

Use this command to define which project the CLI should use by default in the current directory.

nestbox project use <project-name>

This will create or update a .nestboxrc file in the current folder with the following format:

{
  "projects": {
    "default": "<project-name>"
  }
}

Add a Named Project Alias​

You can define multiple project aliases, which allows you to quickly switch between environments (e.g., staging, production).

nestbox project add <project-name> alias=<alias>

For example:

nestbox project add sales-123 alias=prod

This updates .nestboxrc with:

{
  "projects": {
    "default": "project-name",
    "prod": "sales-123"
  }
}

How Project Context Is Used​

When a command requires a project context, the CLI will look for a .nestboxrc file in the current directory or parent directories. If no project is configured and none is specified via --project, the CLI will display an error.

You can always override the default by passing a specific project ID:

nestbox agent deploy <agent-id> --project my-project