Files
ark/website/docs/provider/coordinator/configure-cli.md
Marco Argentieri 8371e9f1c2 rename dev_portal to website (#20)
* rename dev_portal to website

* rename dev_portal to website

* master not main
2023-11-29 00:35:10 +01:00

1.5 KiB

sidebar_position, title
sidebar_position title
5 Configure the CLI

Now that your service is up and running you can configure the coordinator CLI to interact with it.

The CLI makes use of a configuration file stored in its datadir - defaults to ~/.coordinator-cli on Linux, ~/Library/Application\ Support/Coordinator-cli on MacOS.

You can customize the datadir path of your coordinator cli by exporting the environment variable export ARK_COORDINATOR_CLI_DATADIR=path/to/datadir.

:::tip Add this env var to your bash profile otherwise you'll need to always export it when running coordinator commands. :::

You can manage the configuration of your CLI with the features of the coordinator config command. Following, you can learn all what you can do with this command.

Initialize CLI config

You can initialize the configuration of your CLI by the means of flags

$ coordinator config init

This command brings the configuration of your CLI to its default status unless you don't specify a flag for those params you want to tweak.

Run coordinator config init --help to see all available configuration flags.

Customize CLI config

You can change granular params of the CLI's configuration by using the set subcommand as shown below:

$ coordinator config set no-tls true

Show CLI config

You can take a look at the configuration of your CLI with:

$ coordinator config

You've learned everything about configuring the CLI, let's see how it does let you interact with the Coordinator.