Getting started  |  Roadmap  |  Contributing

Aries CLI is the most convenient way for self-sovereign identity (SSI) developers to interact with SSI agents.

• Environments to easily manage configuration for multiple projects and agents
• Automations that you can perform against an agent
• Mock data so that you can focus on the important task of building your application instead of other foobar (coming soon 🚧)

If you are looking for more information about the concepts, example code and tutorials on how to use the CLI we recommend you check out our extensive docs.

Heres how to install Aries-CLI using the most popular package managers. For advanced installation options, binaries and troubleshooting we recommend checking out the installation guide.

brew tap animo/aries-cli 
brew install aries-cli

cargo install --git https://github.com/animo/aries-cli

git clone https://github.com/animo/aries-cli
cd aries-cli

# Run ONE of the following commands to build:
make build

cargo build --release

# Run ONE of the following commands to add install the aries-cli into your PATH
make install 

cargo install --path ./cli

In order to work with the Aries-CLI an agent needs to be configured. With the following command you connect with our community agent and can access all the functionality.

aries-cli configuration add --default

This command will set up the community agent. To set up your own agent or use our multitenant agent to get your own environment, see the set up guide.

If you are getting started with the tool we recommend enabling informational logs by passing the --verbose (or -v) flag.

To see all actions simply use the --help or -h flag or see the feature overview.

We intend to support multiple versions of the Aries agent. See the CLI help aries-cli --help for a list of actions we currently support.

Is there something you'd like to fix or add to the CLI? Great! We 💗 community contributions. Get involved.