diff --git a/README.md b/README.md index 8ff39055..10ec34f8 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,6 @@

Getting started  |  - Common examples  |  Roadmap  |  Contributing @@ -36,34 +35,19 @@ Aries CLI is the most convenient way for self-sovereign identity (SSI) developer * 🌟 **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](https://github.com/animo/aries-cli/pull/www.google.com). +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](https://docs.aries-cli.animo.id/). ## Getting started -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 docs](./docs/advanced_installation.md). +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](https://docs.aries-cli.animo.id/guides/installation). ### macOS using Brew ```sh -echo "Coming soon!" +brew tap animo/aries-cli && brew install aries-cli ``` -### Linux using Apt-get - -```sh -echo "Coming soon!" -``` - -### Windows using Chocolatey - -```powershell -Write-Output "Coming soon!" -``` - -### Binaries - -See [binaries](https://github.com/animo/aries-cli/releases). ### Cargo install ```sh @@ -71,65 +55,48 @@ cargo install --git https://github.com/animo/aries-cli ### Setting up your environment ```sh -aries-cli configuration initialize +aries-cli configuration add --default # > /location/of/the/config/file ``` -This command will set up the community agent. To set up your own agent edit -the configuration file by adding your agent URL. - -If you are getting started with the tool we recommend enabling informational logs by -passing the `--verbose` (or `-v`). - -## Common examples - -To see all actions simply use the `--help` or `-h` flag. Here are some common actions. - -### Create a credential offer - -```sh -aries-cli execute offer-credential -``` - - Get a credential offer in your wallet — this command will execute all of the actions needed. - - -### Create an invitation for the toolbox - -```sh -aries-cli --copy --verbose connections invite --toolbox -``` - -The `--toolbox` flag creates an invitation for the [Toolbox](https://github.com/hyperledger/aries-toolbox). +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](https://docs.aries-cli.animo.id/guides/configuration). -The `--copy` flag will copy the invite URL to your clipboard so it can easily be pasted in the toolbox -Replace `--verbose` with `--quiet` to suppress non-essential output to stdout. +If you are getting started with the tool we recommend enabling informational logs by passing the `--verbose` (or `-v`) flag. -For more options under the `connections invite` subcommand see: +To see all actions simply use the `--help` or `-h` flag or see the [feature overview](https://docs.aries-cli.animo.id/features/introduction). -``` -aries-cli connections invite --help -``` ## Roadmap - 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. -Next we are looking at adding: +| Feature | Status | Description | +| ----------------------------------- | ------ | ------------------------------------------------------------------------------- | +| Environments | ✅ | Support multiple environments. | +| Connections | ✅ | Retrieve connections or create invitations. | +| Schemas | ✅ | Retrieve or create schemas. | +| Credentials | ✅ | Offer or propose credentials. | +| ACA-Py 0.7.3 support | ✅ | ACA-Py 0.7.3 support. | +| Verbosity | ✅ | Three verbosity levels and error messages. | +| Automation: offer credential mocked | ✅ | Offer a mocked data credential through an automation. | +| Community agent | ✅ | Default use with the Animo community agent. | +| Multitenancy | ✅ | Use a personal agent environment with your personal token. | +| Brew install | ✅ | Brew install. | +| Proofs | ✅ | Proofs. | +| Apt-get install | 🚧 | Apt-get install. | +| Chocolaty install | 🚧 | Chocolaty install. | +| Automation: offer credential custom | 🚧 | Offer a custom data credential through an automation. | +| Filters | 🚧 | Use filters to determine what output you want returned. | +| Automation: definitions custom | 🚧 | Create a schema + credential definition with custom data through an automation. | +| Automation: proofs mock | 🚧 | Present proof with mock data through an automation. | +| Automation: proofs custom | 🚧 | Present proof with custom data through an automation. | -| Feature | Status | Description | -| ---------------- | ------ | ------------------------------------------------------------------------------------- | -| Mock data | 🚧 | Generate mock data for large data structures like schemas and credential definitions. | -| Filters | 🚧 | Use filters to determine what server output you want returned. | -| execute offer-credential | ✅ | Execute sequence of actions to get a credential offer in your wallet. | -| Present proof | 🚧 | Present proofs. | ## Contributing Is there something you'd like to fix or add to the CLI? Great! We 💗 community -contributions. [Get involved](./docs/contributing.md). +contributions. [Get involved](https://docs.aries-cli.animo.id/community/contributing).