Skip to content

Commit

Permalink
dont pretty
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronmgdr committed Jan 9, 2024
1 parent 170cfb1 commit d39dd94
Show file tree
Hide file tree
Showing 25 changed files with 216 additions and 33 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,6 @@ jobs:
uses: ./.github/actions/sync-workspace
with:
artifacts_to_cache: ${{ needs.install-dependencies.outputs.artifacts_to_cache }}
- name: Run tests
run: |
yarn workspace @celo/celocli test
- name: Fail if someone forgot to commit CLI docs
run: |
yarn workspace @celo/celocli docs
Expand All @@ -234,6 +231,9 @@ jobs:
git diff
exit 1
fi
- name: Run tests
run: |
yarn workspace @celo/celocli test
- name: Verify that a new account can be created
run: |
yarn workspace @celo/celocli run celocli account:new
Expand Down
1 change: 0 additions & 1 deletion packages/cli/generate_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ export COLUMNS=88
# must replace lib with src so docs link to source code
sed -i -e 's@./lib/commands@./src/commands@g' package.json
yarn oclif readme --multi --dir=../docs/command-line-interface
yarn prettier --write ../docs/command-line-interface/*
sed -i.bak '/^- \[/d' ../docs/command-line-interface/*
rm -rf ../docs/command-line-interface/*.bak
# reverse changes to package.json
Expand Down
35 changes: 33 additions & 2 deletions packages/docs/command-line-interface/account.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,38 @@
# `celocli account`
`celocli account`
=================

Manage your account, keys, and metadata

* [`celocli account:authorize`](#celocli-accountauthorize)
* [`celocli account:balance ARG1`](#celocli-accountbalance-arg1)
* [`celocli account:claim-account ARG1`](#celocli-accountclaim-account-arg1)
* [`celocli account:claim-domain ARG1`](#celocli-accountclaim-domain-arg1)
* [`celocli account:claim-keybase ARG1`](#celocli-accountclaim-keybase-arg1)
* [`celocli account:claim-name ARG1`](#celocli-accountclaim-name-arg1)
* [`celocli account:claim-storage ARG1`](#celocli-accountclaim-storage-arg1)
* [`celocli account:create-metadata ARG1`](#celocli-accountcreate-metadata-arg1)
* [`celocli account:deauthorize`](#celocli-accountdeauthorize)
* [`celocli account:delete-payment-delegation`](#celocli-accountdelete-payment-delegation)
* [`celocli account:get-metadata ARG1`](#celocli-accountget-metadata-arg1)
* [`celocli account:get-payment-delegation`](#celocli-accountget-payment-delegation)
* [`celocli account:list`](#celocli-accountlist)
* [`celocli account:lock ARG1`](#celocli-accountlock-arg1)
* [`celocli account:new`](#celocli-accountnew)
* [`celocli account:offchain-read ARG1`](#celocli-accountoffchain-read-arg1)
* [`celocli account:offchain-write`](#celocli-accountoffchain-write)
* [`celocli account:proof-of-possession`](#celocli-accountproof-of-possession)
* [`celocli account:recover-old`](#celocli-accountrecover-old)
* [`celocli account:register`](#celocli-accountregister)
* [`celocli account:register-data-encryption-key`](#celocli-accountregister-data-encryption-key)
* [`celocli account:register-metadata`](#celocli-accountregister-metadata)
* [`celocli account:set-name`](#celocli-accountset-name)
* [`celocli account:set-payment-delegation`](#celocli-accountset-payment-delegation)
* [`celocli account:set-wallet`](#celocli-accountset-wallet)
* [`celocli account:show ARG1`](#celocli-accountshow-arg1)
* [`celocli account:show-claimed-accounts ARG1`](#celocli-accountshow-claimed-accounts-arg1)
* [`celocli account:show-metadata ARG1`](#celocli-accountshow-metadata-arg1)
* [`celocli account:unlock ARG1`](#celocli-accountunlock-arg1)
* [`celocli account:verify-proof-of-possession`](#celocli-accountverify-proof-of-possession)

## `celocli account:authorize`

Expand Down Expand Up @@ -226,7 +257,7 @@ _See code: [src/commands/account/claim-storage.ts](https://github.com/celo-org/d

## `celocli account:create-metadata ARG1`

Create an empty identity metadata file. Use this metadata file to store claims attesting to ownership of off-chain resources. Claims can be generated with the account:claim-\* commands.
Create an empty identity metadata file. Use this metadata file to store claims attesting to ownership of off-chain resources. Claims can be generated with the account:claim-* commands.

```
USAGE
Expand Down
4 changes: 3 additions & 1 deletion packages/docs/command-line-interface/autocomplete.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# `celocli autocomplete`
`celocli autocomplete`
======================

Display autocomplete installation instructions.

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

## `celocli autocomplete [SHELL]`

Expand Down
4 changes: 3 additions & 1 deletion packages/docs/command-line-interface/commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# `celocli commands`
`celocli commands`
==================

list all the commands

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

## `celocli commands`

Expand Down
5 changes: 4 additions & 1 deletion packages/docs/command-line-interface/config.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# `celocli config`
`celocli config`
================

Configure CLI options which persist across commands

* [`celocli config:get`](#celocli-configget)
* [`celocli config:set`](#celocli-configset)

## `celocli config:get`

Expand Down
9 changes: 8 additions & 1 deletion packages/docs/command-line-interface/dkg.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# `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`

Expand Down
10 changes: 9 additions & 1 deletion packages/docs/command-line-interface/election.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# `celocli election`
`celocli election`
==================

Participate in and view the state of Validator Elections

* [`celocli election:activate`](#celocli-electionactivate)
* [`celocli election:current`](#celocli-electioncurrent)
* [`celocli election:list`](#celocli-electionlist)
* [`celocli election:revoke`](#celocli-electionrevoke)
* [`celocli election:run`](#celocli-electionrun)
* [`celocli election:show ARG1`](#celocli-electionshow-arg1)
* [`celocli election:vote`](#celocli-electionvote)

## `celocli election:activate`

Expand Down
12 changes: 10 additions & 2 deletions packages/docs/command-line-interface/exchange.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# `celocli exchange`
`celocli exchange`
==================

Exchange Celo Dollars and CELO via the stability mechanism

* [`celocli exchange:celo`](#celocli-exchangecelo)
* [`celocli exchange:dollars`](#celocli-exchangedollars)
* [`celocli exchange:euros`](#celocli-exchangeeuros)
* [`celocli exchange:gold`](#celocli-exchangegold)
* [`celocli exchange:reals`](#celocli-exchangereals)
* [`celocli exchange:show`](#celocli-exchangeshow)
* [`celocli exchange:stable`](#celocli-exchangestable)

## `celocli exchange:celo`

Expand Down Expand Up @@ -98,7 +106,7 @@ _See code: [src/commands/exchange/euros.ts](https://github.com/celo-org/develope

## `celocli exchange:gold`

Exchange CELO for StableTokens via the stability mechanism. _DEPRECATION WARNING_ Use the "exchange:celo" command instead
Exchange CELO for StableTokens via the stability mechanism. *DEPRECATION WARNING* Use the "exchange:celo" command instead

```
USAGE
Expand Down
24 changes: 23 additions & 1 deletion packages/docs/command-line-interface/governance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
# `celocli governance`
`celocli governance`
====================

Interact with on-chain governance proposals and hotfixes

* [`celocli governance:approvehotfix`](#celocli-governanceapprovehotfix)
* [`celocli governance:build-proposal`](#celocli-governancebuild-proposal)
* [`celocli governance:dequeue`](#celocli-governancedequeue)
* [`celocli governance:execute`](#celocli-governanceexecute)
* [`celocli governance:executehotfix`](#celocli-governanceexecutehotfix)
* [`celocli governance:hashhotfix`](#celocli-governancehashhotfix)
* [`celocli governance:list`](#celocli-governancelist)
* [`celocli governance:preparehotfix`](#celocli-governancepreparehotfix)
* [`celocli governance:propose`](#celocli-governancepropose)
* [`celocli governance:revokeupvote`](#celocli-governancerevokeupvote)
* [`celocli governance:show`](#celocli-governanceshow)
* [`celocli governance:showaccount`](#celocli-governanceshowaccount)
* [`celocli governance:showhotfix`](#celocli-governanceshowhotfix)
* [`celocli governance:upvote`](#celocli-governanceupvote)
* [`celocli governance:view`](#celocli-governanceview)
* [`celocli governance:viewaccount`](#celocli-governanceviewaccount)
* [`celocli governance:viewhotfix`](#celocli-governanceviewhotfix)
* [`celocli governance:vote`](#celocli-governancevote)
* [`celocli governance:votePartially`](#celocli-governancevotepartially)
* [`celocli governance:whitelisthotfix`](#celocli-governancewhitelisthotfix)
* [`celocli governance:withdraw`](#celocli-governancewithdraw)

## `celocli governance:approvehotfix`

Expand Down
9 changes: 8 additions & 1 deletion packages/docs/command-line-interface/grandamento.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# `celocli grandamento`
`celocli grandamento`
=====================

Cancels a Granda Mento exchange proposal

* [`celocli grandamento:cancel`](#celocli-grandamentocancel)
* [`celocli grandamento:execute`](#celocli-grandamentoexecute)
* [`celocli grandamento:get-buy-amount`](#celocli-grandamentoget-buy-amount)
* [`celocli grandamento:list`](#celocli-grandamentolist)
* [`celocli grandamento:propose`](#celocli-grandamentopropose)
* [`celocli grandamento:show`](#celocli-grandamentoshow)

## `celocli grandamento:cancel`

Expand Down
4 changes: 3 additions & 1 deletion packages/docs/command-line-interface/help.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# `celocli help`
`celocli help`
==============

Display help for celocli.

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

## `celocli help [COMMANDS]`

Expand Down
6 changes: 5 additions & 1 deletion packages/docs/command-line-interface/identity.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# `celocli identity`
`celocli identity`
==================

Interact with ODIS and the attestations service

* [`celocli identity:get-attestations`](#celocli-identityget-attestations)
* [`celocli identity:identifier`](#celocli-identityidentifier)
* [`celocli identity:withdraw-attestation-rewards`](#celocli-identitywithdraw-attestation-rewards)

## `celocli identity:get-attestations`

Expand Down
12 changes: 11 additions & 1 deletion packages/docs/command-line-interface/lockedgold.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,17 @@
# `celocli lockedgold`
`celocli lockedgold`
====================

View and manage locked CELO

* [`celocli lockedgold:delegate`](#celocli-lockedgolddelegate)
* [`celocli lockedgold:delegate-info`](#celocli-lockedgolddelegate-info)
* [`celocli lockedgold:lock`](#celocli-lockedgoldlock)
* [`celocli lockedgold:max-delegatees-count`](#celocli-lockedgoldmax-delegatees-count)
* [`celocli lockedgold:revoke-delegate`](#celocli-lockedgoldrevoke-delegate)
* [`celocli lockedgold:show ARG1`](#celocli-lockedgoldshow-arg1)
* [`celocli lockedgold:unlock`](#celocli-lockedgoldunlock)
* [`celocli lockedgold:update-delegated-amount`](#celocli-lockedgoldupdate-delegated-amount)
* [`celocli lockedgold:withdraw`](#celocli-lockedgoldwithdraw)

## `celocli lockedgold:delegate`

Expand Down
6 changes: 5 additions & 1 deletion packages/docs/command-line-interface/multisig.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# `celocli multisig`
`celocli multisig`
==================

Approves an existing transaction on a multi-sig contract

* [`celocli multisig:approve`](#celocli-multisigapprove)
* [`celocli multisig:show ARG1`](#celocli-multisigshow-arg1)
* [`celocli multisig:transfer ARG1`](#celocli-multisigtransfer-arg1)

## `celocli multisig:approve`

Expand Down
6 changes: 5 additions & 1 deletion packages/docs/command-line-interface/network.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# `celocli network`
`celocli network`
=================

View details about the network, like contracts and parameters

* [`celocli network:contracts`](#celocli-networkcontracts)
* [`celocli network:info`](#celocli-networkinfo)
* [`celocli network:parameters`](#celocli-networkparameters)

## `celocli network:contracts`

Expand Down
5 changes: 4 additions & 1 deletion packages/docs/command-line-interface/node.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# `celocli node`
`celocli node`
==============

Manage your Celo node

* [`celocli node:accounts`](#celocli-nodeaccounts)
* [`celocli node:synced`](#celocli-nodesynced)

## `celocli node:accounts`

Expand Down
7 changes: 6 additions & 1 deletion packages/docs/command-line-interface/oracle.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# `celocli oracle`
`celocli oracle`
================

List oracle addresses for a given token

* [`celocli oracle:list ARG1`](#celocli-oraclelist-arg1)
* [`celocli oracle:remove-expired-reports ARG1`](#celocli-oracleremove-expired-reports-arg1)
* [`celocli oracle:report ARG1`](#celocli-oraclereport-arg1)
* [`celocli oracle:reports ARG1`](#celocli-oraclereports-arg1)

## `celocli oracle:list ARG1`

Expand Down
17 changes: 14 additions & 3 deletions packages/docs/command-line-interface/plugins.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,18 @@
# `celocli plugins`
`celocli plugins`
=================

List installed plugins.

* [`celocli plugins`](#celocli-plugins)
* [`celocli plugins:install PLUGIN...`](#celocli-pluginsinstall-plugin)
* [`celocli plugins:inspect PLUGIN...`](#celocli-pluginsinspect-plugin)
* [`celocli plugins:install PLUGIN...`](#celocli-pluginsinstall-plugin-1)
* [`celocli plugins:link PLUGIN`](#celocli-pluginslink-plugin)
* [`celocli plugins:uninstall PLUGIN...`](#celocli-pluginsuninstall-plugin)
* [`celocli plugins:reset`](#celocli-pluginsreset)
* [`celocli plugins:uninstall PLUGIN...`](#celocli-pluginsuninstall-plugin-1)
* [`celocli plugins:uninstall PLUGIN...`](#celocli-pluginsuninstall-plugin-2)
* [`celocli plugins:update`](#celocli-pluginsupdate)

## `celocli plugins`

Expand Down Expand Up @@ -62,7 +73,7 @@ ALIASES
$ celocli plugins:add
EXAMPLES
$ celocli plugins:add myplugin
$ celocli plugins:add myplugin
$ celocli plugins:add https://github.com/someuser/someplugin
Expand Down Expand Up @@ -132,7 +143,7 @@ ALIASES
$ celocli plugins:add
EXAMPLES
$ celocli plugins:install myplugin
$ celocli plugins:install myplugin
$ celocli plugins:install https://github.com/someuser/someplugin
Expand Down
18 changes: 17 additions & 1 deletion packages/docs/command-line-interface/releasecelo.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,23 @@
# `celocli releasecelo`
`celocli releasecelo`
=====================

View and manage ReleaseGold contracts

* [`celocli releasecelo:authorize`](#celocli-releaseceloauthorize)
* [`celocli releasecelo:create-account`](#celocli-releasecelocreate-account)
* [`celocli releasecelo:locked-gold`](#celocli-releasecelolocked-gold)
* [`celocli releasecelo:refund-and-finalize`](#celocli-releasecelorefund-and-finalize)
* [`celocli releasecelo:revoke`](#celocli-releasecelorevoke)
* [`celocli releasecelo:revoke-votes`](#celocli-releasecelorevoke-votes)
* [`celocli releasecelo:set-account`](#celocli-releaseceloset-account)
* [`celocli releasecelo:set-account-wallet-address`](#celocli-releaseceloset-account-wallet-address)
* [`celocli releasecelo:set-beneficiary`](#celocli-releaseceloset-beneficiary)
* [`celocli releasecelo:set-can-expire`](#celocli-releaseceloset-can-expire)
* [`celocli releasecelo:set-liquidity-provision`](#celocli-releaseceloset-liquidity-provision)
* [`celocli releasecelo:set-max-distribution`](#celocli-releaseceloset-max-distribution)
* [`celocli releasecelo:show`](#celocli-releaseceloshow)
* [`celocli releasecelo:transfer-dollars`](#celocli-releasecelotransfer-dollars)
* [`celocli releasecelo:withdraw`](#celocli-releasecelowithdraw)

## `celocli releasecelo:authorize`

Expand Down
5 changes: 4 additions & 1 deletion packages/docs/command-line-interface/reserve.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# `celocli reserve`
`celocli reserve`
=================

Shows information about reserve

* [`celocli reserve:status`](#celocli-reservestatus)
* [`celocli reserve:transfergold`](#celocli-reservetransfergold)

## `celocli reserve:status`

Expand Down
4 changes: 3 additions & 1 deletion packages/docs/command-line-interface/rewards.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# `celocli rewards`
`celocli rewards`
=================

Show rewards information about a voter, registered Validator, or Validator Group

* [`celocli rewards:show`](#celocli-rewardsshow)

## `celocli rewards:show`

Expand Down
Loading

0 comments on commit d39dd94

Please sign in to comment.