#Core CLI Commands

ARK Core comes packaged with a robust command line interface (CLI) which is an essential tool that enables any node operator to update, manage, or monitor their node installation without the need for external programs.

View the installed version of Core and a list of available CLI commands by typing the following in your terminal:

1ark

#Core

This series of tests will test the core process commands. The ‘core’ process will run both your relay and your forger in a single process. You can start the core process with the following command:

1ark core:start

• Run ark core:status to ensure that the core to check the status of your process.

You can view your core process logs with the following command:

1ark core:log

• Check the logs to ensure that the process has started correctly

You can restart your core process with the following command:

1ark core:restart

• Check your core logs to ensure that the process has restarted successfully

You can stop your core process with the following command.

1ark core:stop

You can run the core process in foreground with the following command

1ark core:run

• Exit the process and ensure that it has stopped from running with ark core:status

#Relay

This series of tests will test the `relay’ process commands. ARK Core allows you to run a relay as a single process without the forger enabled with the following command:

1ark relay:start

• Check that the process is running with ark relay:status
• Check the relay logs with ark relay:log to ensure the process has started correctly.

You can restart your relay process with the following command

1ark relay:restart

• Check that the process is running with ark relay:status
• Check the relay logs with ark relay:log to ensure the process has started correctly.

With 3.0, you can now share your relay process via ngrok . You can do this with the following command:

1ark relay:share

• Check that you can successfully resolve to an API endpoint with the ngrok URL provided.

You can stop your relay process with the following command.

1ark relay:stop

You can run the relay process in foreground with the following command

1ark relay:run

• Exit the process and ensure that it has stopped from running with ark relay:status

#Forger

This series of tests will test the forger process commands. The ‘forger’ process will run your forger in a single process independently of the relay. You can start the core process with the following command:

1ark forger:start

• Check the status of your forger with ark forger:status
• Check the logs to ensure your forger has started correctly and loaded the correct delegate with ark forger:log

You can restart your forger with the following command:

1ark forger:restart

• Check the status of your forger with ark forger:status
• Check the logs to ensure your forger has restarted correctly and loaded the correct delegate with ark forger:log

You can stop your forger process with the following command:

1ark forger:stop

• Check the status of your forger with ark forger:status

You can run the forger process in foreground with the following command

1ark forger:run

• Exit the process and ensure that it has stopped from running with ark forger:status

#Config

ARK Core CLI allows you to configure your Core environment (CLI, database & forger) by using the config commands. For the purpose of this testing, we will just test the database and forger config commands.

To configure your database, run the following command:

1ark config:database

• You should now be prompted to configure a database.
• Configure up your database with your own custom values
• Once completed, run less .config/ark-core/devnet/.env and check your database parameters have now updated correctly.

To configure your forger, run the following command:

1ark config:forger

• Follow the onscreen prompts to complete a BIP39 configuration
• Once complete, run less .config/ark-core/devnet/delegates.json and check your delegate passphrase is updated correctly.
• Run the command again and complete a BIP38 configuration
• Once complete, start your forger process and ensure the correct delegate is loaded after entering password.

#Snapshots

Core CLI allows you to dump, restore, rollback, truncate and verify your database. This series of tests will utilize the CLI to perform actions with your database.

To create a full snapshot of your database, you can run the following command:

1ark snapshot:dump

• Ensure the process completes without errors.
• Make a note of the filename of your snapshot. This will look like 1-5235743

Once you have taken a snapshot of your database, you can restore the snapshot with the following command:

1ark snapshot:restore --blocks snapshot
2 
3// example:
4ark snapshot:restore --blocks 1-5235743

• Ensure the snapshot restores without errors
• Start your relay and ensure your node begins to sync to the network correctly

To rollback your node to a specific block height you can use the following command

1ark snapshot:rollback --height=blockHeight
2 
3// example
4ark snapshot:rollback --height=5641500

• Rollback your node to a block height of your choosing and ensure the process completes successfully
• Start your relay and check that your node will now begin syncing from the specified block height that you rolled back to