Skip to main content

Agents

This page covers all commands related to agent management in the Nestbox AI CLI. Agents are at the core of the platform and represent deployable AI logic. This section includes commands for listing, creating, deploying, and removing agents.

List Agents​

List all agents in the project:

nestbox agent list

To list agents in another project:

nestbox agent list --project <project-id>

Options:

  • --project <projectId> – Project ID or name (defaults to the current project)

Create an Agent​

Create a single agent or all agents defined in nestbox-agents.yaml:

nestbox agent create --agent <agent-name> --instance <machine-name>

Create with additional options:

nestbox agent create \
--agent <agent-name> \
--instance <machine-name> \
--type REGULAR \
--description "My agent goal" \
--inputSchema '{"type":"object","properties":{"prompt":{"type":"string"}}}'

Create all agents defined in nestbox-agents.yaml:

nestbox agent create --all --instance <machine-name>

Options:

  • --agent <agent> – Agent name to create
  • --all – Create all agents defined in nestbox-agents.yaml
  • --project <project> – Project ID (defaults to current project)
  • --type <type> – Agent type (e.g. CHAT, AGENT, REGULAR)
  • --description <description> – Description of the agent
  • --instance <instance> – Machine name
  • --inputSchema <inputSchema> – Agent input schema

Deploy an Agent​

Deploy an AI agent to the Nestbox AI platform. Deploy uses the same YAML (and flag) semantics as create. It zips your project root, uploads the code, and updates metadata.

Deploy a single agent:

nestbox agent deploy --agent <agent-name> --instance <machine-name>

Deploy all agents from nestbox-agents.yaml:

nestbox agent deploy --all --instance <machine-name>

Deploy with verbose logging:

nestbox agent deploy --all --instance <machine-name> --log

Deploy with a custom prefix:

nestbox agent deploy --agent <agent-name> --instance <machine-name> --prefix "v2-"

Options:

  • --agent <agent> – Agent name to deploy
  • --all – Deploy all agents defined in nestbox-agents.yaml
  • --prefix <prefix> – A prefix added to beginning of the agent name
  • --description <description> – Goal/description of the agent
  • --inputSchema <inputSchema> – Agent input schema
  • --project <project> – Project ID (defaults to current project)
  • --type <type> – Agent type (e.g. CHAT, AGENT, REGULAR)
  • --entryFunction <entryFunction> – Entry function name
  • --instance <instance> – Machine name
  • --log – Show detailed logs during deployment
  • --silent – Disable automatic agent creation

Behavior:

  • If the agent does not exist, you'll be prompted to create it (skip prompt with --silent).
  • --entryFunction overrides the YAML entry for this deploy.
  • --prefix applies during deploy as well (names become prefix-<agent>).

Remove an Agent​

Remove an agent from the platform:

nestbox agent remove <agent-name>

Parameters:

  • <agent-name> – Name of the agent to remove

Options:

  • --project <projectId> – Project ID or name (defaults to the current project)