This guide will walk you through the basic functions to get you started with the Veramo CLI by learning the basic commands and issuing a credential. The core API of Veramo is exposed by the CLI tool. All major functions can be executed locally using the CLI tool.
The CLI tool is currently only supported on MACOS and Linux systems. Windows support is coming soon.
You can also use a per-project configuration or specify a configuration file with each command.
If the current folder contains an agent.yml configuration file, it will be used instead of the .veramo/agent.yml path.
Alternatively, you can specify a config file with each command using the --config /path/to/your/config.yml option. This will be used instead of a per-project or default configuration file.
You can create a configuration file in the current folder by running:
veramo config create
This will create an agent.yml file that will get used next time you invoke a CLI command in this folder.
By default, the database files are created in the same folder as the config file.
# From outside the directory
veramo did create --config ./myagent/agent.yml
# It will detect a local agent.yml file when run from within the myagent directory