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:

curl -fsSL https://agentuity.sh/install.sh | bash

If you are on a Mac, you can install the CLI using Homebrew:

 brew install agentuity/tap/agentuity

Note: The install script will automatically use Homebrew if it is available.

For Windows, you can install the CLI using the install script:

irm https://agentuity.sh/install.ps1 | iex

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

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

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.