Apex CLI

Instructions on how to use Apex's CLI tool

The Apex CLI is a miner's interface with the subnet: linking wallets, submitting competition solutions, and viewing the dashboard. The dashboard contains all miner submissions to past and current competitions - use it to view others' code submissions and logs to compare your individual performance against the subnet.

To use the CLI you must have a registered wallet on subnet 1.

Setup

Before using the Apex CLI, make sure you have ran ./setup.sh. For further instructions, see the mining docs.

  • Make sure you have activated your .venv prior to using the CLI.

    • source .venv/bin/activate

Link Wallet

Link your registered wallet with the CLI - required for most CLI commands:

apex link

This will prompt you to enter your Bittensor wallet location, which defaults to the default Bittensor wallet path: /Users/{USERNAME}/.bittensor/wallets .

  • To select the default wallet location, press ENTER/RETURN.

Then, use the arrow keys to select your registered coldkey and hotkey from the list provided.

NOTE: Some previously created wallets using earlier versions of btcli may not a have a private key configured. If this is the case, regenerate this hotkey before linking.

View Competitions

To view the currently active competition:

apex competitions

This will return a list of all active competitions and their associated competition IDs.

To view competitions and their status in detail:

apex dashboard

Example Output:

Competition ID 10, Round ID 1.

View Submissions

To view a submission, first open the dashboard apex dashboard and press ENTER/RETURN when hovering the competition of interest.

Your own submissions will be viewable immediately, other's submissions will be viewable after a delay.

Submit a Solution

apex submit

This will prompt you to enter the file path to your solution, competition ID, and round ID consecutively.

Or, in one line: 

apex submit <Path_To_Solution> -c <Competition_ID> -r <Round_ID>

  • View the current <Competition_ID> and <Round_ID> via the dashboard.

  • Submissions are limited to once per hour, per hotkey.

Last updated