cli

README

Build Agents, Not Infrastructure

Agentuity CLI

The command line tools for the Agentuity Agent Cloud Platform. These tools are used to build, manage, and deploy Agents to the Agentuity platform.

Installation

You can install the CLI using the install script (Linux, macOS, or WSL):

curl -fsS https://agentuity.sh | sh

If you are on a Mac, you can install the CLI using Homebrew (by default, the install script will use Homebrew if it is installed and not disabled):

brew install agentuity/tap/agentuity

You can force the install script to use the direct binary install (not Homebrew) with:

curl -fsS https://agentuity.sh | sh -s -- --no-brew

Windows: Native Windows installation is no longer supported. Please use Windows Subsystem for Linux (WSL) and run the install script from your WSL terminal.

For other platforms, please download the binary from the Releases page.

Supported platforms:

• Linux
• macOS
• Windows (via WSL only)

Upgrade

If you have already installed the CLI, you can upgrade to the latest version using the upgrade command:

agentuity upgrade

You can check the current version with:

agentuity version

You can check if there is a newer version:

agentuity version check

Use the --upgrade flag to automatically upgrade if a newer version is found:

agentuity version check --upgrade

Usage

agentuity --help

Usage

The Agentuity CLI provides a comprehensive set of commands to help you build, manage, and deploy Agents. Here's an overview of the available commands:

Basic Commands

# Display help information
agentuity --help

# Check the CLI version
agentuity version

# Login to the Agentuity Cloud Platform
agentuity login

Project Management

# Create a new project
agentuity create [name]
# or
agentuity project create [name] [--dir <directory>] [--provider <provider>]

# List all projects
agentuity project list

# Delete one or more projects
agentuity project delete

Agent Management

# Create a new agent
agentuity agent create

# List all Agents in the project
agentuity agent list

# Delete one or more Agents
agentuity agent delete

# Test an Agent by sending a payload to its webhook
agentuity agent test --agent-id <agent_id> --payload '{"key": "value"}'

Development and Deployment

# Run the development server
agentuity dev

# Deploy your project to the cloud
agentuity deploy
# or
agentuity cloud deploy [--dir <directory>]

Other Commands

# Environment related commands
agentuity env

# Authentication and authorization
agentuity auth

For more detailed information about any command, you can use:

agentuity [command] --help

Development

Error Code System

The CLI uses a centralized error code system to provide consistent error messages and codes. Error codes are defined in error_codes.yaml at the root of the project and are automatically generated into Go code.

To add a new error code:

1. Edit error_codes.yaml and add a new entry with a unique code and descriptive message
2. Run go generate ./... to update the Go code
3. Use the generated error type in your code with errsystem.New(errsystem.ErrYourError, err)

For more details, see the Error Code System documentation.

Templates

The CLI provides a set of templates for building Agents. These templates are used to create new Agent projects and are stored in the agentuity/templates repository. See the Templates README for more details.

License

See the LICENSE file for details.

Documentation

Overview

Copyright © 2025 Agentuity, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.