Skip to main content

Introduction to the CLI

The Nestbox AI CLI is a command-line interface designed to facilitate development, management, and deployment of AI agents built on the Nestbox AI platform. It provides developers streamlined commands for authentication, deployment lifecycle management, AI agent management, document processing, and AI-assisted configuration generation.

Quick Start​

  1. Login to your Nestbox AI platform:
nestbox login <nestbox-domain>
  1. List available projects:
nestbox project list
  1. Set default project:
nestbox project use <project-name>
  1. Deploy an agent:
nestbox agent deploy --agent <agent-name> --instance <machine-name>

Global Options​

nestbox [options] [command]

Options:
-V, --version            output the version number
-h, --help               display help for command

Key Capabilities​

The Nestbox AI CLI enables you to:

  • Authenticate with a Nestbox AI deployment
    Securely log in to any Nestbox AI instance using Google SSO, with tokens stored locally for future use.

  • Manage projects
    List, configure, and switch between multiple projects. Project context can be saved per directory using .nestboxrc.

  • Control compute instances
    List, create, and delete compute instances that host and run your agents.

  • Deploy and manage AI agents
    Create, deploy, list, and remove agents. Supports single agent operations or bulk operations via nestbox-agents.yaml manifest.

  • Manage documents and collections
    Create and update collections, upload files, manage document records, and perform semantic or filtered searches via CLI commands.

  • Manage images
    List available compute images for deploying instances.

  • Process documents with AI pipelines
    Upload documents, run processing jobs, manage profiles, run evaluations, execute batch queries, and configure webhooks — all through the doc-proc command group.

  • Generate configurations with AI
    Use AI-assisted generation (Anthropic Claude or OpenAI GPT) to produce validated YAML configurations for document processing pipelines and report composers from plain-English instruction files.

The CLI integrates directly with the Nestbox AI API and is intended to be used alongside local development environments and automated workflows.

Configuration​

The CLI stores authentication and configuration data in ~/.config/.nestbox/. This includes:

  • Authentication tokens for different domains
  • Default project settings
  • Project aliases

Error Handling​

The CLI includes automatic token refresh functionality. If your authentication token expires, the CLI will attempt to refresh it automatically. If this fails, you'll need to login again using the login command.