Skip to content

CLI Reference

Complete command reference for the AAM (Agent Artifact Manager) command-line interface.

Quick Reference

Getting Started

Command Description
aam init Set up AAM (platform, default sources)

Package Management

Command Description
aam install Install a package and its dependencies
aam uninstall Remove an installed package
aam upgrade Upgrade outdated source-installed packages
aam outdated Check for outdated packages
aam search Search registries and sources (relevance-ranked)
aam list List installed packages (--available for sources)
aam info Show detailed package information

Package Integrity

Command Description
aam verify Verify installed file checksums
aam diff Show unified diffs for modified files

Package Authoring (aam pkg)

Command Description
aam pkg init Scaffold a new package from scratch
aam pkg create Create package from existing project
aam pkg validate Validate package manifest and artifacts
aam pkg pack Build distributable .aam archive
aam pkg publish Publish package to registry
aam pkg build Build portable platform-specific bundle

Source Management

Command Description
aam source add Add a remote git repository as source
aam source scan Scan a source for artifacts
aam source update Fetch upstream changes
aam source list List configured sources
aam source remove Remove a configured source
aam source candidates List unpackaged artifact candidates
aam source enable-defaults Enable all default community skill sources

Registry Management

Command Description
aam registry init Create a new local registry
aam registry add Add a registry source
aam registry list List configured registries
aam registry remove Remove a registry source

Configuration

Command Description
aam config set Set a configuration value
aam config get Get a configuration value
aam config list List all configuration values

Global Options

All commands support these global options:

Option Short Description
--verbose -v Enable verbose output with debug logging
--version Show AAM version and exit
--help -h Show command help and exit

See Global Options for detailed information about global flags and environment variables.

Command Conventions

Package Specifiers

AAM supports multiple package specifier formats:

  • name - Install latest version from registry or source
  • name@version - Install specific version
  • @scope/name - Scoped package from registry
  • source/artifact - Qualified name from a specific source
  • ./path/ - Install from local directory
  • file.aam - Install from archive file

Exit Codes

All AAM commands follow standard exit code conventions:

Code Meaning
0 Success
1 General error (validation, network, permissions)
2 Command usage error (invalid arguments)

Getting Help

aam --help              # Show all commands
aam install --help      # Show install command options
aam pkg --help          # Show package authoring commands
aam source --help       # Show source management commands