Skip to content

CLI Commands Reference

This document provides a comprehensive reference for all AgentCore CLI commands, their options, and usage examples.

Command Structure

AgentCore CLI follows a consistent command structure:

Bash
1
agentcore-cli [global-options] <command-group> <command> [options] [arguments]
  • Global Options: Apply to all commands (e.g., --verbose, --config)
  • Command Group: Logical grouping of related commands (e.g., agent, env)
  • Command: Specific action to perform (e.g., create, list)
  • Options: Command-specific flags and settings (e.g., --dockerfile, --region)
  • Arguments: Required inputs for the command (e.g., agent name)

Global Options

Option Description
--version Show version and exit
--config PATH Path to config file (default: .agentcore/config.json)
--verbose, -v Enable verbose logging
--quiet, -q Suppress non-error output
--help, -h Show help message and exit

Command Groups

AgentCore CLI organizes commands into logical groups:

  • init

    Initialize and set up your AgentCore project.

  • agent

    Create, update, invoke, and manage agent runtimes.

  • env

    Manage environments (dev, staging, prod).

  • container

    Build, push, and manage Docker containers.

  • config

    Configure and synchronize your AgentCore setup.

  • resources

    Manage AWS resources (ECR, IAM, Cognito).

Quick Command Reference

Below is a quick reference for commonly used commands:

Initialization

Bash
1
2
3
4
5
# Interactive setup wizard
agentcore-cli init

# Non-interactive setup
agentcore-cli init --no-interactive --region us-west-2 --environment dev

Agent Management

Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
# Create a new agent
agentcore-cli agent create my-bot --dockerfile ./Dockerfile

# Update an existing agent
agentcore-cli agent update my-bot --image-tag v2

# Invoke an agent
agentcore-cli agent invoke my-bot --prompt "Hello!"

# List all agents in current environment
agentcore-cli agent list

# Show agent status
agentcore-cli agent status my-bot

# Delete an agent
agentcore-cli agent delete my-bot

Environment Management

Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Create environment
agentcore-cli env create prod --region us-east-1

# Switch to environment
agentcore-cli env use prod

# List environments
agentcore-cli env list

# Show current environment
agentcore-cli env current

# Delete environment
agentcore-cli env delete old-env --force

Container Operations

Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Build container
agentcore-cli container build my-bot --dockerfile ./Dockerfile

# Push to ECR
agentcore-cli container push my-bot --tag v1.0.0

# List images
agentcore-cli container list --repository my-bot

# Pull image
agentcore-cli container pull my-bot --tag v1.0.0

# Remove container image
agentcore-cli container remove my-bot --local-only

Configuration Management

Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Show current configuration
agentcore-cli config show

# Export configuration
agentcore-cli config export --file backup.json

# Import configuration
agentcore-cli config import backup.json

# Enable cloud sync
agentcore-cli config sync enable --auto

# Check sync status
agentcore-cli config sync status

Resource Management

Bash
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# ECR Resources
agentcore-cli resources ecr create my-repo
agentcore-cli resources ecr list
agentcore-cli resources ecr delete old-repo --force

# IAM Resources
agentcore-cli resources iam create my-agent
agentcore-cli resources iam list

# Cognito Resources
agentcore-cli resources cognito create my-agent
agentcore-cli resources cognito list

Getting Help

For detailed help on any command, use the --help flag:

Bash
1
2
3
4
5
6
7
8
# General help
agentcore-cli --help

# Command group help
agentcore-cli agent --help

# Specific command help
agentcore-cli agent create --help

Next Steps

For detailed information about specific command groups, visit their individual pages: