Open sacha-l opened 2 years ago
Template for a CLI tool (apply to all subcommands):
To install and compile the {tool
} program:
The basic syntax for running {tool
} commands is:
tool [subcommand] [flag]
You can use the following optional flags with the {tool
} command.
You can use the following subcommands with the {tool
} command.
For reference information and examples that illustrate using {tool
} subcommands, select an appropriate command.
Command | Description |
---|---|
Depending on the subcommand you specify, the output from the {tool
} program displays some or all of the following information:
This field | Contains |
---|---|
To {describe some use}, run the following command:
tool --use
Use the {tool subcommand} command to {what the subcommand does}.
tool subcommand [FLAGS] [OPTIONS] <signature> <uri>
You can use the following optional flags with the {tool subcommand
} command.
Flag | Description |
---|---|
You can use the following command-line options with the {tool subcommand
} command.
Option | Description |
---|---|
{2-3 examples on ways to use this subcommand and any relevant explanations}
The initial scaffolding just ports over some lean content about each tool. Now that we're treating each tool as a first class citizen, we need to provide proper write-ups for each one.
See: https://github.com/substrate-developer-hub/docs-sandbox/pull/16 for reference on a template to follow.
Currently working on:
See working branch: https://github.com/substrate-developer-hub/docs-sandbox/tree/sl/tools-reference-section