Introduction

Overview

Transactions

Installation

Security

Deployment

Development Guides

Testing

Releases

Support

All Available CLI Commands

Available Commands

help

You might be used to tab completion, which the ARK CLI does support. Using this command ARK CLI but does show you instructions.

Usage

ark help

config:cli

Configure the CLI

Usage

ark config:cli

Flags

Name Description Required
--token the name of the token that should be used :x:
--channel the npm registry channel that should be used :x:

Examples

Use the “mine” token for configuration

ark config:cli --token="mine"

Switch to the Next Channel

ark config:cli --channel="next"

config:database

Configure the database

Usage

ark config:database

Omitting all flags will start the configuration in an interactive mode.

Flags

Name Description Required
--host the host of the database :x:
--port the port of the database :x:
--database the name of the database that should be used :x:
--username the name of the database user :x:
--password the password for the database that should be used :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

ark config:database --host=localhost --port=5432 --database=ark_mainnet --username=ark --password=password

config:forger

Configure the forging delegate

Usage

ark config:forger

Omitting all flags will start the configuration in an interactive mode.

Flags

Name Description Required
--bip39 the plain text bip39 passphrase :x:
--password the password for the encrypted bip38 :x:
--method the configuration method to use (bip38 or bip39) :x:
--skipValidation skip bip39 mnemonic validation :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Configure a Delegate Using an Encrypted BIP38

ark config:forger --method=bip38 --bip39="..." --password="..."

Configure a Delegate Using a BIP39 Passphrase

ark config:forger --method=bip39 --bip39="..."

config:forger:bip38

Configure a delegate using an encrypted BIP38

Usage

ark config:forger:bip38

Flags

Name Description Required
--bip39 the plain text bip39 passphrase :white_check_mark:
--password the password for the encrypted bip38 :white_check_mark:
--skipValidation skip bip39 mnemonic validation :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

ark config:forger:bip38 --bip38="..." --password="..."

config:forger:bip39

Configure a delegate using a BIP39 passphrase

Usage

ark config:forger:bip39

Flags

Name Description Required
--bip39 the plain text bip39 passphrase :white_check_mark:
--skipValidation skip bip39 mnemonic validation :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

ark config:forger:bip39 --bip39="..."

config:publish

Publish the configuration

Usage

ark config:publish

Flags

Name Description Required
--bip39 the plain text bip39 passphrase :white_check_mark:
--skipValidation skip bip39 mnemonic validation :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Publish the Configuration

ark config:publish

Flags

Name Description Required
--reset overwrite existing configuration :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Reset the Configuration for the Mainnet Network

ark config:publish --network=mainnet --reset

core:log

Show the core log

Usage

ark core:log

Flags

Name Description Required
--error only show error output :x:
--lines number of lines to output :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

ark core:log

core:restart

Restart the core

Usage

ark core:restart

Flags

Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Restart the Core

ark core:restart

core:start

Start the core

Usage

ark core:start

Flags

Name Description Required
--bip39 the plain text bip39 passphrase :x:
--bip38 the encrypted bip38 :x:
--password the password for the encrypted bip38 :x:
--[no-]daemon start the process as a pm2 daemon :x:
--disableDiscovery permanently disable any peer discovery :x:
--ignoreMinimumNetworkReach ignore the minimum network reach on start :x:
--launchMode the mode the relay will be launched in (seed only at the moment) :x:
--networkStart indicate that this is the first start of seeds :x:
--skipDiscovery skip the initial peer discovery :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Run Core With a Daemon

ark core:start

Run Core as Genesis

ark core:start --networkStart

Disable Any Discovery by Other Peers

ark core:start --disableDiscovery

Skip the Initial Discovery

ark core:start --skipDiscovery

Ignore the Minimum Network Reach

ark core:start --ignoreMinimumNetworkReach

Start a Seed

ark core:start --launchMode=seed

Run Core Without a Daemon

ark core:start --no-daemon

or use the following command, which supports the same set of flags.:

ark core:run

core:status

Display core status

Usage

ark core:status

Flags

Name Description Required
--token the name of the token that should be used :x:

core:stop

Stop the core

Usage

ark core:stop

Flags

Name Description Required
--daemon stop the process or pm2 daemon :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Stop the Core

ark core:stop

Stop the Core Daemon

ark core:stop --daemon

env:get

Get the value of an environment variable

Usage

ark env:get --key=KEY

Flags

Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:
--key the key of which the value should be retrieved :white_checkmark:

Examples

Get the Log Level

ark env:get --key=CORE_LOG_LEVEL

env:list

List all environment variables

Usage

ark env:list

Flags

Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

List All Environment Variables

ark env:list

env:paths

Get all of the environment paths

Usage

ark env:paths

Flags

Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

List All Environment Paths

ark env:paths

env:set

Set the value of an environment variable

Usage

ark env:set --key=KEY --value=VALUE

Flags

Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:
--key the key of the value that should be updated :white_checkmark:
--value the new value of the key that should be updated :white_checkmark:

Examples

Set the Log Level

ark env:set --key=CORE_LOG_LEVEL --value=info

forger:log

Show the forger log

Usage

ark forger:log

Flags

Name Description Required
--error only show error output :x:
--lines number of lines to output :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

ark forger:log

forger:restart

Restart the forger

Usage

ark forger:restart

Flags

Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Restart the Forger

ark forger:restart

forger:start

Start the forger

Usage

ark forger:start

or the equivalent, without invoking pm2:

ark forger:run

Flags

Name Description Required
--bip39 the plain text bip39 passphrase :x:
--bip38 the encrypted bip38 :x:
--password the password for the encrypted bip38 :x:
--[no-]daemon start the process as a pm2 daemon :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Run a Forger With a bip39 Passphrase

ark forger:start --bip39="..."

Run a Forger With an Encrypted bip38

ark forger:start --bip38="..." --password="..."

Run a Forger Without a Daemon

ark forger:start --no-daemon

forger:status

Display forger status

Usage

ark forger:status

Flags

Name Description Required
--token the name of the token that should be used :x:

forger:stop

Stop the forger

Usage

ark forger:stop

Flags

Name Description Required
--daemon stop the process or pm2 daemon :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Stop the Forger

ark forger:stop

Stop the Forger Daemon

ark forger:stop --daemon

forger:status

Show the forger status.

Usage

ark forger:status

Flags

Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Example

ark forger:status

relay:log

Show the relay log

Usage

ark relay:log

Flags

Name Description Required
--error only show error output :x:
--lines number of lines to output :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

ark relay:log

relay:restart

Restart the relay

Usage

ark relay:restart

Flags

Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Restart the Relay

ark relay:restart

relay:start

Start the relay

Usage

ark relay:start

or the equivalent without using pm2:

ark relay:run

Flags

Name Description Required
--[no-]daemon start the process as a pm2 daemon :x:
--disableDiscovery permanently disable any peer discovery :x:
--ignoreMinimumNetworkReach ignore the minimum network reach on start :x:
--launchMode=launchMode the mode the relay will be launched in (seed only at the moment) :x:
--networkStart indicate that this is the first start of seeds :x:
--skipDiscovery skip the initial peer discovery :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Run a Relay With a pm2 Daemon

ark relay:start --network=mainnet

Run a Genesis Relay

ark relay:start --networkStart

Disable Any Discovery by Other Peers

ark relay:start --disableDiscovery

Skip the Initial Discovery

ark relay:start --skipDiscovery

Ignore the Minimum Network Reach

ark relay:start --ignoreMinimumNetworkReach

Start a Seed

ark relay:start --launchMode=seed

Run a Relay Without a Daemon

ark relay:start --no-daemon

relay:status

Display relay status

Usage

ark relay:status

Flags

Name Description Required
--token the name of the token that should be used :x:

relay:stop

Stop the relay

Usage

ark relay:stop

Flags

Name Description Required
--daemon stop the process or pm2 daemon :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

Examples

Stop the Relay

ark relay:stop

Stop the Relay Daemon

ark relay:stop --daemon

top

List all core daemons

Usage

ark top

Examples

List All Core Daemons

ark top

snapshot:dump

Create a dump of the database

Usage

ark snapshot:dump

Flags

Name Description Required
--start [default: -1] start network height to export :x:
--end [default: -1] end network height to export :x:
--skipCompression skip gzip compression :x:
--codec codec name :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

snapshot:restore

Restore the database from a dump

Usage

ark snapshot:restore

Flags

Name Description Required
--verify signature verification :x:
--truncate truncate database before rollback :x:
--blocks blocks to append to, correlates to folder name
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

snapshot:rollback

Roll back the database to a specific height or by a specified number of blocks

Usage

ark snapshot:rollback

Flags

Either height or number has to be provided.

Name Description Required
--height block network height number to roll back to :ballot_box_with_check:
--number number of blocks to roll back :ballot_box_with_check:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

snapshot:truncate

Truncate the database

Usage

ark snapshot:truncate
Name Description Required
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

snapshot:verify

Verify snapshot

Usage

ark snapshot:verify

Flags

Name Description Required
--blocks snapshot folder name :x:
--network the name of the network that should be used :x:
--token the name of the token that should be used :x:

plugin:install

Install a plugin from an npm package name, git repository url or local file.

Usage

ark plugin:install {npm|git|file}
NPM
ark plugin:install @vendor/pkg
Git
ark plugin:install [email protected]:vendor/pkg.git
Usage
ark plugin:install /path/to/some/vendor/pkg.tar.gz

plugin:update

Update a plugin based on its name. If the name contains a scope like @arkecosystem than this scope needs to be included.

Usage

ark plugin:update {package}

plugin:remove

Remove a plugin based on its name. If the name contains a scope like @arkecosystem than this scope needs to be included.

Usage

ark plugin:remove {package}
2021 © ARK.io | All Rights Reserved
An ARK.io Product