diff --git a/docs/guides/configuration.md b/docs/guides/configuration.md index fe7b54ca..03e217c3 100644 --- a/docs/guides/configuration.md +++ b/docs/guides/configuration.md @@ -7,7 +7,7 @@ description: >- # Configuration -### Basic configuration +### Basic configuration After installation, the CLI prompts you to initialize your configuration with the following command. @@ -25,21 +25,21 @@ configurations: token: ~ ``` -The config file contains an endpoint for the agent that handles all of your CLI actions. By default, this is the URL for the Animo community agent. Using this agent, you can get started right away without any further setup. +The config file contains an endpoint for the agent that handles all of your CLI actions. By default, this is the URL for the Animo community agent. Using this agent, you can get started right away without any further setup. You might find, however, that you want some more advanced configuration in order to avoid the clutter of the community agent (as you will encounter the actions of everyone using it). No worries! In a few easy steps, you can set up your own tenant environment or connect your own agent instead. -### Advanced configuration - use our multitenant agent +### Advanced configuration - use our multitenant agent -With a tenant you don't have to worry about the connections, schema's and credentials of other community members. You get your own agent to use however you like. +With a tenant you don't have to worry about the connections, schema's and credentials of other community members. You get your own agent to use however you like. -To use our meltitenant agent to set up your own tenant, simply: +To use our multitenant agent to set up your own tenant, simply: -* Choose to [claim your token via the Aries CLI website](https://aries-cli.animo.id). -* Connect your GitHub account by following the instructions that pop up. -* Copy the command that appears and run it in your terminal. +* Choose to [claim your token via the Aries CLI website](https://aries-cli.animo.id). +* Connect your GitHub account by following the instructions that pop up. +* Copy the command that appears and run it in your terminal. -The `config.yaml` will now be overwritten (or created if you hadn't initialized yet) with a 'default' environment. +The `config.yaml` will now be overwritten (or created if you hadn't initialized yet) with a 'default' environment. ```yaml configurations: @@ -49,11 +49,9 @@ configurations: token: ``` -This new environment contains the endpoint for the agent that handles all of your CLI actions (in this case, the URL of our tenant agent). It also contains a custom token you claimed by connecting your GitHub account. You can now use a subtenant of the Animo community agent to execute all CLI commands. - -The Aries CLI uses the 'default' environment when no `--environment ` flag is given. Having your own tenant will help a lot with keeping your development process clear, however, if you already have a development agent you might want to consider either adding an environment for it or switching over to it completely. - +This new environment contains the endpoint for the agent that handles all of your CLI actions (in this case, the URL of our tenant agent). It also contains a custom token you claimed by connecting your GitHub account. You can now use a subtenant of the Animo community agent to execute all CLI commands. +The Aries CLI uses the 'default' environment when no `--environment ` flag is given. Having your own tenant will help a lot with keeping your development process clear, however, if you already have a development agent you might want to consider either adding an environment for it or switching over to it completely. ### Additional configuration - using your own agent @@ -68,7 +66,7 @@ configurations: token: ~ ``` -You can add new environments by using the `configuration add` command and specifying the environment name, agent endpoint, API key (optional) and token (optional) in the `config.yaml`. +You can add new environments by using the `configuration add` command and specifying the environment name, agent endpoint, API key (optional) and token (optional) in the `config.yaml`. ``` aries-cli configuration add --environment= --agent-url= --api-key= --token= @@ -76,6 +74,14 @@ aries-cli configuration add --environment= --agent-url=` flag. -The Aries CLI uses the 'default' environment when no `--environment` flag is given. If you want to use another environment as your default, you can override your current default environment by specifying `--environment= default` in the above command. +The Aries CLI uses the 'default' environment when no `--environment` flag is given. If you want to use another environment as your default, you can override your current default environment by specifying `--environment= default` in the above command. +```yaml +--- +configurations: + : + endpoint: + api_key: + token: +``` diff --git a/docs/guides/installation.md b/docs/guides/installation.md index 835ae36e..be12d6b8 100644 --- a/docs/guides/installation.md +++ b/docs/guides/installation.md @@ -1,7 +1,7 @@ --- description: >- There are several ways to install the Aries CLI, depending on your system and - preferences. Currently the methods are limited, but we're working on adding + preferences. Currently the methods are limited but we're working on adding more. --- @@ -15,7 +15,7 @@ Currently, the Aries CLI supports Brew as a package manager. brew install aries-cli ``` -For other systems than macOS, we recommend installing with Cargo, or installing through the binaries. +For other systems than macOS we recommend installing with Cargo, or installing through the binaries. ### Installing with Cargo @@ -29,7 +29,7 @@ This method of install will **not** update automatically and is therefore not re ### Installing through binaries -The binaries can be downloaded from the[ website](https://aries-cli.animo.id) under the `Get Started` dropdown or from the [GitHub releases](https://github.com/animo/aries-cli/releases). This method of install will **not** update automatically and is therefore not recommended if another option is available to you. We have binaries available for: +The binaries can be downloaded from the[ website](https://aries-cli.animo.id)`under`the `Get started` dropdown or from the [GitHub releases](https://github.com/animo/aries-cli/releases). This method of install will **not** update automatically and is therefore not recommended if another option is available to you. We have binaries available for: * Windows (aries-cli.exe) * macOS (Silicon) (aries-cli-macos-arm)