Skip to main content

Introduction to the CLI

The Nestbox AI CLI is a command-line interface that provides developers with full access to the Nestbox AI platform for building, deploying, and managing AI agents and related infrastructure.

It is designed to streamline development workflows by offering direct control over projects, compute instances, agent deployment, and document management—all from the terminal.

Key Capabilities​

The Nestbox AI CLI enables you to:

  • Authenticate with a Nestbox AI deployment
    Securely log in to any Nestbox AI instance using a domain-based authentication flow, with tokens stored locally for future use.

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

  • Control compute instances
    List, create, and remove compute instances that host and run your agents. Select from available images and configure options like GPU types.

  • Generate and deploy AI agents
    Scaffold new agents with a predefined structure, customize them locally, and deploy them to a selected compute instance.

  • Monitor agent events
    Stream or inspect logs and system events generated by your deployed agents to aid debugging and monitoring.

  • Manage documents and collections
    Create and update collections, upload files, manage document records, and perform vector-based searches via CLI commands.

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