Installation
Insructions for installing the CLI
The Agentuity CLI is a command line tool for managing your Agentuity projects. It's a cross-platform tool that can be used on Windows (using WSL), MacOS, and Linux.
Install Script
The easiest way to install the Agentuity CLI is to use the install script. This script will automatically detect your operating system and install the appropriate version of the CLI.
The install script for Windows only works in the WSL (Windows Subsystem for Linux) environment
On MacOS, if you have Homebrew installed, the install script will automatically use brew for installation.
Version
To print the version of the Agentuity CLI:
You can also use the -v flag to print the version:
To check if you have the latest version of the Agentuity CLI:
Upgrading
To upgrade to the latest version of the Agentuity CLI:
For more details on the version command, see the CLI Version Commands.
Manual Installation
You can also manually download and install the Agentuity CLI from the GitHub releases page for any platform:
- Visit the Agentuity CLI releases page
- Download the appropriate version for your operating system
- Extract the downloaded file
- Add the executable to your system PATH
Source Code
The source code for the Agentuity CLI is available on GitHub.
Shell Completions
The Agentuity CLI provides shell completions for bash, zsh, fish, and PowerShell. These can help make your command line experience more efficient by providing tab-completion for commands and options.
Automatic Setup
When you install the CLI using the installer scripts, completions are automatically set up for:
- Bash and Zsh on MacOS and Linux (when you have write permissions to the completion directories)
Manual Setup
You can manually set up completions for any supported shell using the agentuity completion command.
To load completions in your current bash session:
To load completions for every new session:
For Linux:
For MacOS:
Note: This depends on the bash-completion package. If not already installed, you can install it via your OS's package manager.
Need Help?
Join our Community for assistance or just to hang with other humans building agents.
Send us an email at hi@agentuity.com if you'd like to get in touch.
Please Follow us on
If you haven't already, please Signup for your free account now and start building your first agent!