Skip to content

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

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
106 changes: 68 additions & 38 deletions docs/cli/account.md
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions docs/cli/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ DESCRIPTION
Output network node configuration
```

_See code: [lib/commands/config/get.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/config/get.js)_
_See code: [src/commands/config/get.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/config/get.ts)_

## `celocli config:set`

Expand Down Expand Up @@ -74,7 +74,8 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/config/set.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/config/set.js)_
_See code: [src/commands/config/set.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/config/set.ts)_
21 changes: 14 additions & 7 deletions docs/cli/election.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/election/activate.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/election/activate.js)_
_See code: [src/commands/election/activate.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/election/activate.ts)_

## `celocli election:current`

Expand Down Expand Up @@ -162,10 +163,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/election/current.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/election/current.js)_
_See code: [src/commands/election/current.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/election/current.ts)_

## `celocli election:list`

Expand Down Expand Up @@ -206,10 +208,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/election/list.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/election/list.js)_
_See code: [src/commands/election/list.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/election/list.ts)_

## `celocli election:revoke`

Expand Down Expand Up @@ -271,10 +274,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/election/revoke.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/election/revoke.js)_
_See code: [src/commands/election/revoke.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/election/revoke.ts)_

## `celocli election:run`

Expand Down Expand Up @@ -311,10 +315,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/election/run.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/election/run.js)_
_See code: [src/commands/election/run.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/election/run.ts)_

## `celocli election:show ARG1`

Expand Down Expand Up @@ -349,10 +354,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/election/show.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/election/show.js)_
_See code: [src/commands/election/show.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/election/show.ts)_

## `celocli election:vote`

Expand Down Expand Up @@ -415,7 +421,8 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/election/vote.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/election/vote.js)_
_See code: [src/commands/election/vote.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/election/vote.ts)_
19 changes: 13 additions & 6 deletions docs/cli/epochs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

Expand Down Expand Up @@ -104,10 +105,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/epochs/finish.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/epochs/finish.js)_
_See code: [src/commands/epochs/finish.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/epochs/finish.ts)_

## `celocli epochs:process-groups`

Expand Down Expand Up @@ -163,10 +165,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/epochs/process-groups.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/epochs/process-groups.js)_
_See code: [src/commands/epochs/process-groups.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/epochs/process-groups.ts)_

## `celocli epochs:send-validator-payment`

Expand Down Expand Up @@ -229,10 +232,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/epochs/send-validator-payment.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/epochs/send-validator-payment.js)_
_See code: [src/commands/epochs/send-validator-payment.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/epochs/send-validator-payment.ts)_

## `celocli epochs:start`

Expand Down Expand Up @@ -288,10 +292,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/epochs/start.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/epochs/start.js)_
_See code: [src/commands/epochs/start.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/epochs/start.ts)_

## `celocli epochs:status`

Expand Down Expand Up @@ -329,10 +334,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/epochs/status.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/epochs/status.js)_
_See code: [src/commands/epochs/status.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/epochs/status.ts)_

## `celocli epochs:switch`

Expand Down Expand Up @@ -391,7 +397,8 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/epochs/switch.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/epochs/switch.js)_
_See code: [src/commands/epochs/switch.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/epochs/switch.ts)_
18 changes: 12 additions & 6 deletions docs/cli/exchange.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/exchange/celo.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/exchange/celo.js)_
_See code: [src/commands/exchange/celo.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/exchange/celo.ts)_

## `celocli exchange:dollars`

Expand Down Expand Up @@ -145,10 +146,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/exchange/dollars.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/exchange/dollars.js)_
_See code: [src/commands/exchange/dollars.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/exchange/dollars.ts)_

## `celocli exchange:euros`

Expand Down Expand Up @@ -212,10 +214,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/exchange/euros.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/exchange/euros.js)_
_See code: [src/commands/exchange/euros.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/exchange/euros.ts)_

## `celocli exchange:reals`

Expand Down Expand Up @@ -279,10 +282,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/exchange/reals.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/exchange/reals.js)_
_See code: [src/commands/exchange/reals.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/exchange/reals.ts)_

## `celocli exchange:show`

Expand Down Expand Up @@ -338,10 +342,11 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/exchange/show.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/exchange/show.js)_
_See code: [src/commands/exchange/show.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/exchange/show.ts)_

## `celocli exchange:stable`

Expand Down Expand Up @@ -410,7 +415,8 @@ FLAG DESCRIPTIONS
Alias options:
local, localhost => 'http://localhost:8545'
alfajores => Celo Alfajores Testnet,
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

_See code: [lib/commands/exchange/stable.js](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.0.1/packages/cli/lib/commands/exchange/stable.js)_
_See code: [src/commands/exchange/stable.ts](https://github.com/celo-org/developer-tooling/tree/%40celo/celocli%407.1.0-beta.1/packages/cli/src/commands/exchange/stable.ts)_
Loading