Creating CLI Commands

With the release of Core 3.0 we’ve introduced a new pluggable CLI. It enables developers to implement their own commands or replace existing ones with their own implementations. In this guide we’ll run you through the steps that are needed to get your plugin that provides your commands up developed and published on NPM.

Prerequisites

This guide assumes that you’re already familiar with how to setup Core for development so we’ll skip that part, if you’re not familiar with it you should read our guide before going any further. You’ll also need to be familiar with the basics of TypeScript and how to build projects with it.

The Command

The command we’ll build in this guide is a command to share your local development relay with others through ngrok . Below you can find the command that we’ll break down from top to bottom and eventually package all of it into a plugin that we’ll publish on NPM.

1import { Commands, Container } from "@arkecosystem/core-cli";
2import Joi from "@hapi/joi";
3import ngrok from "ngrok";
4 
5@Container.injectable()
6export class Command extends Commands.Command {
7 /**
8 * The console command signature.
9 *
10 * @type {string}
11 * @memberof Command
12 */
13 public signature: string = "relay:share";
14 
15 /**
16 * The console command description.
17 *
18 * @type {string}
19 * @memberof Command
20 */
21 public description: string = "Share the Relay via ngrok.";
22 
23 /**
24 * Configure the console command.
25 *
26 * @returns {void}
27 * @memberof Command
28 */
29 public configure(): void {
30 this.definition
31 .setFlag("proto", "Choose one of the available protocols (http|tcp|tls).", Joi.string().default("http"))
32 .setFlag("addr", "Port or network address.", Joi.string().default(4003))
33 .setFlag("auth", "HTTP basic authentication for tunnel.", Joi.string())
34 .setFlag("subdomain", "Reserved tunnel name https://core.ngrok.io.", Joi.string())
35 .setFlag("authtoken", "Your authtoken from ngrok.com.", Joi.string())
36 .setFlag("region", "Choose one of the ngrok regions (us|eu|au|ap).", Joi.string().default("eu"));
37 }
38 
39 /**
40 * Execute the console command.
41 *
42 * @returns {Promise<void>}
43 * @memberof Command
44 */
45 public async execute(): Promise<void> {
46 const url: string = await ngrok.connect({
47 proto: this.getFlag("proto"),
48 addr: this.getFlag("addr"),
49 auth: this.getFlag("auth"),
50 subdomain: this.getFlag("subdomain"),
51 authtoken: this.getFlag("authtoken"),
52 region: this.getFlag("region"),
53 });
54 
55 this.components.info(`Public access to your API: ${url}`);
56 }
57}

Signature

The signature of a command is what the user will type to execute the command. When you for example run ark relay:start you are executing a command with the signature relay:start. You should always namespace your commands unless it is a standalone command without any relationship to anything specific, like listing all processes is the top command without any prefix because it isn’t specifically related to a single thing.

Description

The description of a command is what the user will see if they use either the CLI help or specifically the Command help. Keep it short and concise so the user knows what he can expect from your command.

Configure

The configure method of a command is where you prepare everything that is required for your command to function. Generally this will only be the registration of arguments and flags but if necessary you could also register things like file paths in this method. Keep in mind that this method has no access to the parsed arguments and flags as you’ve just registered them, they will be parsed later.

Execute

The execute method of a command is where all of your business logic is executed. This method will be called last after the command has been configured, arguments have been parsed and interactions have been performed. This method can’t return any values as they will not be used and would violate the void return assumption that is made.

Publishing to NPM

Now that your command is ready you need to publish it on npm so that other people can install it. Before publishing the package to npm you’ll need to make sure that you’ve changed all information to match yours, like name description, author and version. Once that is done you can simply run npm publish and see it published on the npm registry within a few seconds.

Installing from NPM

You can install plugin via CLI command. Replace @vendor/package with your package name and –network with desired network configuration.

1ark plugin:install @vendor/package --network=testnet

Information

Private NPM repository location like Verdaccio can be used and set via CORE_NPM_REGISTRY env variable.

Plugins are installed on default data location inside /plugins folder. You can check default location with:

1ark env:variables

Check if installed plugin is successfully recognized and loaded.

1ark help --network=testnet

Information

To successfully load CLI plugin you need to provide –network flag, since plugins are installed for each network (testnet, devnet, mainnet) separately.

Optionally you can also define custom data path using CORE_PATH_DATA env variable.

Run installed plugin

After successful plugin installation it is time to run plugin.

1ark relay:share --network=testnet
Last updated 6 months ago
Edit Page
Share:
2022 © ARK.io | All Rights Reserved
An ARK.io Product