Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update auto-generated docs reference from developer-tooling #1606

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,506 changes: 1,082 additions & 424 deletions docs/cli/account.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/cli/autocomplete.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Display autocomplete installation instructions.

* [`celocli autocomplete [SHELL]`](#celocli-autocomplete-shell)

## `celocli autocomplete [SHELL]` {#celocli-autocomplete-shell}
## `celocli autocomplete [SHELL]`

Display autocomplete installation instructions.

Expand Down Expand Up @@ -34,4 +34,4 @@ EXAMPLES
$ celocli autocomplete --refresh-cache
```

_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.5/src/commands/autocomplete/index.ts)_
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.2.0/src/commands/autocomplete/index.ts)_
4 changes: 2 additions & 2 deletions docs/cli/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ list all the commands

* [`celocli commands`](#celocli-commands)

## `celocli commands` {#celocli-commands}
## `celocli commands`

list all the commands

Expand Down Expand Up @@ -37,4 +37,4 @@ DESCRIPTION
list all the commands
```

_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v3.1.1/src/commands/commands.ts)_
_See code: [@oclif/plugin-commands](https://github.com/oclif/plugin-commands/blob/v3.3.4/src/commands/commands.ts)_
50 changes: 29 additions & 21 deletions docs/cli/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,53 +6,51 @@ Configure CLI options which persist across commands
* [`celocli config:get`](#celocli-configget)
* [`celocli config:set`](#celocli-configset)

## `celocli config:get` {#celocli-configget}
## `celocli config:get`

Output network node configuration

```
USAGE
$ celocli config:get [--gasCurrency <value>] [--globalHelp]
$ celocli config:get [-n <value>] [--globalHelp]

FLAGS
--gasCurrency=0x1234567890123456789012345678901234567890 Use a specific gas currency
for transaction fees
(defaults to CELO if no gas
currency is supplied). It
must be a whitelisted token.
--globalHelp View all available global
flags
-n, --node=<value> URL of the node to run commands against or an alias
--globalHelp View all available global flags

DESCRIPTION
Output network node configuration

FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias

Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [src/commands/config/get.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/config/get.ts)_

## `celocli config:set` {#celocli-configset}
## `celocli config:set`

Configure running node information for propagating transactions to network

```
USAGE
$ celocli config:set [-n <value>] [--gasCurrency <value>] [--globalHelp]
$ celocli config:set [-n <value>] [--globalHelp]

FLAGS
-n, --node=<value>
URL of the node to run commands against (defaults to 'http://localhost:8545')

--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.

--globalHelp
View all available global flags
-n, --node=<value> URL of the node to run commands against or an alias
--globalHelp View all available global flags

DESCRIPTION
Configure running node information for propagating transactions to network

EXAMPLES
set --node mainnet # alias for `forno`
set --node celo # alias for `forno`

set --node forno # alias for https://forno.celo.org

Expand All @@ -67,6 +65,16 @@ EXAMPLES
set --node ws://localhost:2500

set --node <geth-location>/geth.ipc

FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias

Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [src/commands/config/set.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/config/set.ts)_
Loading