-
Notifications
You must be signed in to change notification settings - Fork 299
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update the CLI docs to use the developer-tooling repository as a subm…
…odule (#1211) * chore: add submodule * chore: replace files by symlink to submodule * fix: missing references * chore: replace symlinks by hardcopies
- Loading branch information
1 parent
b71bb10
commit daef610
Showing
29 changed files
with
2,880 additions
and
2,196 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[submodule "submodules/developer-tooling"] | ||
path = submodules/developer-tooling | ||
url = https://github.com/celo-org/developer-tooling.git |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,37 @@ | ||
# `celocli autocomplete` | ||
`celocli autocomplete` | ||
====================== | ||
|
||
display autocomplete installation instructions | ||
Display autocomplete installation instructions. | ||
|
||
* [`celocli autocomplete [SHELL]`](#celocli-autocomplete-shell) | ||
|
||
## `celocli autocomplete [SHELL]` | ||
|
||
display autocomplete installation instructions | ||
Display autocomplete installation instructions. | ||
|
||
``` | ||
display autocomplete installation instructions | ||
USAGE | ||
$ celocli autocomplete [SHELL] | ||
$ celocli autocomplete [SHELL] [-r] | ||
ARGUMENTS | ||
SHELL shell type | ||
SHELL (zsh|bash|powershell) Shell type | ||
OPTIONS | ||
FLAGS | ||
-r, --refresh-cache Refresh cache (ignores displaying instructions) | ||
DESCRIPTION | ||
Display autocomplete installation instructions. | ||
EXAMPLES | ||
$ celocli autocomplete | ||
$ celocli autocomplete bash | ||
$ celocli autocomplete zsh | ||
$ celocli autocomplete powershell | ||
$ celocli autocomplete --refresh-cache | ||
``` | ||
|
||
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.1.5/src/commands/autocomplete/index.ts)_ | ||
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.5/src/commands/autocomplete/index.ts)_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,40 @@ | ||
# `celocli commands` | ||
`celocli commands` | ||
================== | ||
|
||
list all the commands | ||
|
||
* [`celocli commands`](#celocli-commands) | ||
|
||
## `celocli commands` | ||
|
||
list all the commands | ||
|
||
``` | ||
list all the commands | ||
USAGE | ||
$ celocli commands | ||
OPTIONS | ||
-h, --help show CLI help | ||
-j, --json display unfiltered api data in json format | ||
-x, --extended show extra columns | ||
--columns=columns only show provided columns (comma-separated) | ||
--csv output is csv format [alias: --output=csv] | ||
--filter=filter filter property by partial string matching, ex: name=foo | ||
--hidden show hidden commands | ||
--no-header hide table header from output | ||
--no-truncate do not truncate output to fit screen | ||
--output=csv|json|yaml output in a more machine friendly format | ||
--sort=sort property to sort by (prepend '-' for descending) | ||
$ celocli commands [--json] [--deprecated] [-h] [--hidden] [--tree] | ||
[--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] | ||
[--output csv|json|yaml | | ] [--sort <value>] | ||
FLAGS | ||
-h, --help Show CLI help. | ||
-x, --extended show extra columns | ||
--columns=<value> only show provided columns (comma-separated) | ||
--csv output is csv format [alias: --output=csv] | ||
--deprecated show deprecated commands | ||
--filter=<value> filter property by partial string matching, ex: name=foo | ||
--hidden show hidden commands | ||
--no-header hide table header from output | ||
--no-truncate do not truncate output to fit screen | ||
--output=<option> output in a more machine friendly format | ||
<options: csv|json|yaml> | ||
--sort=<value> property to sort by (prepend '-' for descending) | ||
--tree show tree of commands | ||
GLOBAL FLAGS | ||
--json Format output as json. | ||
DESCRIPTION | ||
list all the commands | ||
``` | ||
|
||
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v1.3.0/src/commands/commands.ts)_ | ||
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v3.1.1/src/commands/commands.ts)_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,131 +1,142 @@ | ||
# `celocli dkg` | ||
`celocli dkg` | ||
============= | ||
|
||
Publish your locally computed DKG results to the blockchain | ||
|
||
* [`celocli dkg:allowlist`](#celocli-dkgallowlist) | ||
* [`celocli dkg:deploy`](#celocli-dkgdeploy) | ||
* [`celocli dkg:get`](#celocli-dkgget) | ||
* [`celocli dkg:publish`](#celocli-dkgpublish) | ||
* [`celocli dkg:register`](#celocli-dkgregister) | ||
* [`celocli dkg:start`](#celocli-dkgstart) | ||
|
||
## `celocli dkg:allowlist` | ||
|
||
Allowlist an address in the DKG | ||
|
||
``` | ||
Allowlist an address in the DKG | ||
USAGE | ||
$ celocli dkg:allowlist | ||
$ celocli dkg:allowlist --participantAddress <value> --address <value> --from | ||
<value> [--globalHelp] | ||
OPTIONS | ||
FLAGS | ||
--address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address | ||
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender | ||
--globalHelp View all available global flags | ||
--participantAddress=participantAddress (required) Address of the | ||
--participantAddress=<value> (required) Address of the | ||
participant to allowlist | ||
DESCRIPTION | ||
Allowlist an address in the DKG | ||
``` | ||
|
||
_See code: [src/commands/dkg/allowlist.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/allowlist.ts)_ | ||
_See code: [src/commands/dkg/allowlist.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/dkg/allowlist.ts)_ | ||
|
||
## `celocli dkg:deploy` | ||
|
||
Deploys the DKG smart contract | ||
|
||
``` | ||
Deploys the DKG smart contract | ||
USAGE | ||
$ celocli dkg:deploy | ||
$ celocli dkg:deploy --phaseDuration <value> --threshold <value> --from | ||
<value> [--globalHelp] | ||
OPTIONS | ||
FLAGS | ||
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender | ||
--globalHelp View all available global flags | ||
--phaseDuration=phaseDuration (required) Duration of each DKG | ||
--phaseDuration=<value> (required) Duration of each DKG | ||
phase in blocks | ||
--threshold=threshold (required) The threshold to use for | ||
--threshold=<value> (required) The threshold to use for | ||
the DKG | ||
DESCRIPTION | ||
Deploys the DKG smart contract | ||
``` | ||
|
||
_See code: [src/commands/dkg/deploy.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/deploy.ts)_ | ||
_See code: [src/commands/dkg/deploy.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/dkg/deploy.ts)_ | ||
|
||
## `celocli dkg:get` | ||
|
||
Gets data from the contract to run the next phase | ||
|
||
``` | ||
Gets data from the contract to run the next phase | ||
USAGE | ||
$ celocli dkg:get | ||
OPTIONS | ||
--address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG | ||
Contract Address | ||
$ celocli dkg:get --method | ||
shares|responses|justifications|participants|phase|group --address <value> | ||
[--globalHelp] | ||
--globalHelp View all | ||
available global | ||
flags | ||
FLAGS | ||
--address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address | ||
--globalHelp View all available global flags | ||
--method=<option> (required) Getter method to call | ||
<options: | ||
shares|responses|justifications| | ||
participants|phase|group> | ||
--method=(shares|responses|justifications|participants|phase|group) (required) Getter | ||
method to call | ||
DESCRIPTION | ||
Gets data from the contract to run the next phase | ||
``` | ||
|
||
_See code: [src/commands/dkg/get.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/get.ts)_ | ||
_See code: [src/commands/dkg/get.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/dkg/get.ts)_ | ||
|
||
## `celocli dkg:publish` | ||
|
||
Publishes data for each phase of the DKG | ||
|
||
``` | ||
Publishes data for each phase of the DKG | ||
USAGE | ||
$ celocli dkg:publish | ||
$ celocli dkg:publish --data <value> --address <value> --from <value> | ||
[--globalHelp] | ||
OPTIONS | ||
FLAGS | ||
--address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address | ||
--data=data (required) Path to the data | ||
--data=<value> (required) Path to the data | ||
being published | ||
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender | ||
--globalHelp View all available global flags | ||
DESCRIPTION | ||
Publishes data for each phase of the DKG | ||
``` | ||
|
||
_See code: [src/commands/dkg/publish.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/publish.ts)_ | ||
_See code: [src/commands/dkg/publish.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/dkg/publish.ts)_ | ||
|
||
## `celocli dkg:register` | ||
|
||
Register a public key in the DKG | ||
|
||
``` | ||
Register a public key in the DKG | ||
USAGE | ||
$ celocli dkg:register | ||
$ celocli dkg:register --blsKey <value> --address <value> --from <value> | ||
[--globalHelp] | ||
OPTIONS | ||
FLAGS | ||
--address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address | ||
--blsKey=blsKey (required) | ||
--blsKey=<value> (required) | ||
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender | ||
--globalHelp View all available global flags | ||
DESCRIPTION | ||
Register a public key in the DKG | ||
``` | ||
|
||
_See code: [src/commands/dkg/register.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/register.ts)_ | ||
_See code: [src/commands/dkg/register.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/dkg/register.ts)_ | ||
|
||
## `celocli dkg:start` | ||
|
||
Starts the DKG | ||
|
||
``` | ||
Starts the DKG | ||
USAGE | ||
$ celocli dkg:start | ||
$ celocli dkg:start --address <value> --from <value> [--globalHelp] | ||
OPTIONS | ||
FLAGS | ||
--address=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) DKG Contract Address | ||
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) Address of the sender | ||
--globalHelp View all available global flags | ||
DESCRIPTION | ||
Starts the DKG | ||
``` | ||
|
||
_See code: [src/commands/dkg/start.ts](https://github.com/celo-org/celo-monorepo/tree/master/packages/cli/src/commands/dkg/start.ts)_ | ||
_See code: [src/commands/dkg/start.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/dkg/start.ts)_ |
Oops, something went wrong.