CLI Reference

The Aurite Command Line Interface (CLI) is the primary tool for interacting with the Aurite framework. It allows you to initialize projects, manage configurations, run agents and workflows, and start services.

Commands

The CLI is organized into several main commands.

aurite init aurite list aurite show aurite run aurite api:material-desktop-mac: aurite studio aurite edit

Initializes a new Aurite project or workspace.

Argument / Option	Type	Description
`[NAME]`	`string`	An optional name for the new project or workspace.
`-p`, `--project`	`flag`	Initialize a new project.
`-w`, `--workspace`	`flag`	Initialize a new workspace.

Interactive Wizard

Running aurite init without options starts an interactive wizard to guide you through creating a project or workspace (recommended).

Inspects and lists configurations for different component types. If run without a subcommand, it displays a complete index of all available components.

Subcommand	Description
`all`	Lists all available component configurations, grouped by type.
`agents`	Lists all available agent configurations.
`llms`	Lists all available LLM configurations.
`mcp_servers`	Lists all available MCP server configurations.
`linear_workflows`	Lists all available linear workflow configurations.
`custom_workflows`	Lists all available custom workflow configurations.
`workflows`	Lists all workflow configurations (both linear and custom).
`index`	Prints the entire component index as a formatted table.

Examples

# List all available agents
aurite list agents

# List all workflows (linear and custom)
aurite list workflows

Displays the detailed configuration for a specific component or all components of a certain type.

Argument / Option	Type	Description
`<NAME_OR_TYPE>`	`string`	The name of a specific component (e.g., `my_agent`) or a component type (e.g., `agents`).
`-f`, `--full`	`flag`	Display the complete, unabridged configuration.
`-s`, `--short`	`flag`	Display a compact, summary view.

Examples

# Show the full configuration for the "Weather Agent"
aurite show "Weather Agent" --full

# Show a summary of all linear workflow configurations
aurite show linear_workflows -s

Executes a runnable framework component, such as an agent or a workflow.

Argument / Option	Type	Description
`[NAME]`	`string`	The name of the component to run.
`[USER_MESSAGE]`	`string`	The initial user message or input to provide to the component.
`--system-prompt`	`string`	Override the agent's default system prompt for this run.
`-id`, `--session-id`	`string`	Specify a session ID to maintain conversation history.
`-s`, `--short`	`flag`	Display a compact, one-line summary of the run output.
`-d`, `--debug`	`flag`	Display the full, raw event stream for debugging.

Execution Behavior

Interactive Chat: Running an agent by NAME without a USER_MESSAGE launches an interactive chat TUI.
Single-Shot: Providing a USER_MESSAGE runs the component once and streams the output to the terminal.

Examples

# Run the "Weather Agent" in interactive chat mode
aurite run "Weather Agent"

# Run the "Weather Agent" once with a specific question
aurite run "Weather Agent" "What is the weather in London?"

# Run the "Weather Planning Workflow"
aurite run "Weather Planning Workflow" "Plan a trip to Paris next week"

# Run the "Example Custom Workflow" with JSON input
aurite run "Example Custom Workflow" '{"city": "Tokyo"}'

Starts the Aurite FastAPI server, which exposes the framework's functionality via a REST API. This is used to power web frontends and programmatic integrations.

aurite api

Starts the Aurite Studio integrated development environment, which launches both the API server and React frontend concurrently. This provides a unified development experience with automatic dependency management and graceful shutdown handling.

Option	Description
`--rebuild-fresh`	Clean all build artifacts and rebuild frontend packages from scratch

Integrated Development Environment

The studio command automatically:

Validates Node.js and npm dependencies
Installs frontend workspace dependencies if needed
Builds frontend packages when artifacts are missing
Starts the API server (if not already running)
Launches the React development server on port 3000
Provides unified logging with [API] and [STUDIO] prefixes
Handles graceful shutdown with Ctrl+C

System Requirements

Node.js >= 18.0.0
npm >= 8.0.0

Examples

# Start the integrated development environment
aurite studio

# Start with a fresh rebuild of frontend packages
aurite studio --rebuild-fresh

Fresh Rebuild Process

When using --rebuild-fresh, the command performs:

Clean Build Artifacts: Runs npm run clean to remove all build outputs
Clear npm Cache: Removes node_modules/.cache directory
Rebuild Packages: Runs npm run build to rebuild all workspace packages
Start Servers: Proceeds with normal server startup

Ports Used

API Server: Configured port (default 8000)
Studio UI: http://localhost:3000

Starts the Aurite configuration editor TUI, a powerful terminal-based interface for creating and modifying component configurations.

Argument	Type	Description
`[COMPONENT_NAME]`	`string`	(Optional) The name of a component to open directly for editing.

TUI Interface

The editor features a three-pane layout for navigation, component listing, and editing, with interactive widgets and dropdowns for easy configuration.

Examples

# Open the TUI editor
aurite edit

# Open the "Weather Agent" configuration directly in the editor
aurite edit "Weather Agent"

Global Options

These options can be used with the base aurite command.

Option	Description
`--install-completion`	Installs shell completion for the `aurite` command.
`--show-completion`	Displays the shell completion script to be sourced or saved manually.
`--help`	Shows the main help message listing all commands.