Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: borngraced <[email protected]>
  • Loading branch information
borngraced committed Dec 5, 2023
1 parent 5f3e2ab commit 336930e
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions mm2src/komodefi_cli/src/doc/CLI_REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ Now `komodefi-cli` is built and available in the `bin` directory and can be call

`komodefi-cli` should be configured in a proper way to be able to connect to and interract with the running `mm2` service via the Komodo RPC API. The `mm2` can be started manually or by using the `komodefi-cli` that facilitates configuring and managing it as a process.

### Setting the Default CLI Root
You can customize the default root directory for `komodefi-cli` by setting the `KOMODEFI_CLI_ROOT` environment variable. This allows you to specify a location for saving configuration files, binaries, and other related data.

```ssh
export KOMODEFI_CLI_ROOT=$HOME/komodefi-cli
komodefi-cli mm2 download
```

### init

The `init` command is aiming to facilitate creating of the `MM2.json` configuration file and getting the `coins` configuration. The `komodefi-cli` implements it in an interactive step-by-step mode and produces `MM2.json` as a result. `coins` configuration is got from the https://raw.githubusercontent.com/KomodoPlatform/coins/master/coins. The `init` also provides alternative paths setting by additional options.
Expand Down Expand Up @@ -65,6 +73,14 @@ resulting `MM2.json`:
}
```

### mm2 download
Download the latest version of `mm2` binary and save to `KOMODEFI_CLI_ROOT` dir.

Usage:
```
komodefi-cli mm2 download
```

### mm2 start

The `start` command is used to start `mm2` instance. Options are used to be set as an environment variables of the `mm2 `: `MM_CONF_PATH`, `MM_COINS_PATH` and `MM_LOG` accordingly.
Expand Down

0 comments on commit 336930e

Please sign in to comment.