diff --git a/packages/cli/generate_docs.sh b/packages/cli/generate_docs.sh index dfe4dd29c..904996cd3 100755 --- a/packages/cli/generate_docs.sh +++ b/packages/cli/generate_docs.sh @@ -1,10 +1,6 @@ #!/usr/bin/env bash set -e 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 sed -i.bak '/^- \[/d' ../docs/command-line-interface/* rm -rf ../docs/command-line-interface/*.bak -# reverse changes to package.json -sed -i -e 's@./src/commands@./lib/commands@g' package.json diff --git a/packages/cli/src/commands/account/get-metadata.ts b/packages/cli/src/commands/account/get-metadata.ts index 2fbcf1627..8a7c1f597 100644 --- a/packages/cli/src/commands/account/get-metadata.ts +++ b/packages/cli/src/commands/account/get-metadata.ts @@ -7,7 +7,7 @@ import { displayMetadata } from '../../utils/identity' export default class GetMetadata extends BaseCommand { static description = - 'Show information about an address. Retreives the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able.' + 'Show information about an address. Retrieves the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able.' static flags = { ...BaseCommand.flags, diff --git a/packages/cli/src/commands/account/register-metadata.ts b/packages/cli/src/commands/account/register-metadata.ts index 913622649..e884b52c6 100644 --- a/packages/cli/src/commands/account/register-metadata.ts +++ b/packages/cli/src/commands/account/register-metadata.ts @@ -9,13 +9,13 @@ import { displayMetadata } from '../../utils/identity' export default class RegisterMetadata extends BaseCommand { static description = - 'Register metadata URL for an account where users will be able to retieve the metadata file and verify your claims' + 'Register metadata URL for an account where users will be able to retrieve the metadata file and verify your claims' static flags = { ...BaseCommand.flags, from: CustomFlags.address({ required: true, - description: 'Addess of the account to set metadata for', + description: 'Address of the account to set metadata for', }), url: Flags.url({ required: true, diff --git a/packages/cli/src/commands/exchange/stable.ts b/packages/cli/src/commands/exchange/stable.ts index d2f631e2d..dfebf5d5d 100644 --- a/packages/cli/src/commands/exchange/stable.ts +++ b/packages/cli/src/commands/exchange/stable.ts @@ -11,7 +11,7 @@ export default class ExchangeStable extends ExchangeStableBase { ...ExchangeStableBase.flags, stableToken: Flags.option({ options: Object.keys(stableTokenOptions) as (StableToken | Lowercase)[], - description: 'Name of the stable token to be transfered', + description: 'Name of the stable token to be transferred', })(), } diff --git a/packages/cli/src/commands/network/contracts.ts b/packages/cli/src/commands/network/contracts.ts index bfabc436e..02bc9208d 100644 --- a/packages/cli/src/commands/network/contracts.ts +++ b/packages/cli/src/commands/network/contracts.ts @@ -17,7 +17,7 @@ const UNVERSIONED_CONTRACTS = [ const UNPROXIED_CONTRACTS: CeloContract[] = [] export default class Contracts extends BaseCommand { - static description = 'Lists Celo core contracts and their addesses.' + static description = 'Lists Celo core contracts and their addresses.' static flags = { ...BaseCommand.flags, diff --git a/packages/cli/src/commands/releasecelo/refund-and-finalize.ts b/packages/cli/src/commands/releasecelo/refund-and-finalize.ts index b3322caa2..594acb69e 100644 --- a/packages/cli/src/commands/releasecelo/refund-and-finalize.ts +++ b/packages/cli/src/commands/releasecelo/refund-and-finalize.ts @@ -4,7 +4,7 @@ import { ReleaseGoldBaseCommand } from '../../utils/release-gold-base' export default class RefundAndFinalize extends ReleaseGoldBaseCommand { static description = - "Refund the given contract's balance to the appopriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances." + "Refund the given contract's balance to the appropriate parties and destroy the contact. Can only be called by the release owner of revocable ReleaseGold instances." static flags = { ...ReleaseGoldBaseCommand.flags, diff --git a/packages/cli/src/commands/transfer/stable.ts b/packages/cli/src/commands/transfer/stable.ts index e16f20b9b..1f6fc18bf 100644 --- a/packages/cli/src/commands/transfer/stable.ts +++ b/packages/cli/src/commands/transfer/stable.ts @@ -11,7 +11,7 @@ export default class TransferStable extends TransferStableBase { ...TransferStableBase.flags, stableToken: Flags.option({ options: Object.keys(stableTokenOptions) as (StableToken | Lowercase)[], - description: 'Name of the stable to be transfered', + description: 'Name of the stable to be transferred', })(), } diff --git a/packages/docs/command-line-interface/account.md b/packages/docs/command-line-interface/account.md index a52e6b2ce..db963d79d 100644 --- a/packages/docs/command-line-interface/account.md +++ b/packages/docs/command-line-interface/account.md @@ -408,7 +408,7 @@ _See code: [src/commands/account/delete-payment-delegation.ts](https://github.co ## `celocli account:get-metadata ARG1` -Show information about an address. Retreives the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able. +Show information about an address. Retrieves the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able. ``` USAGE @@ -453,7 +453,7 @@ FLAGS property to sort by (prepend '-' for descending) DESCRIPTION - Show information about an address. Retreives the metadata URL for an account from the + Show information about an address. Retrieves the metadata URL for an account from the on-chain, then fetches the metadata file off-chain and verifies proofs as able. EXAMPLES @@ -897,7 +897,7 @@ _See code: [src/commands/account/register-data-encryption-key.ts](https://github ## `celocli account:register-metadata` -Register metadata URL for an account where users will be able to retieve the metadata file and verify your claims +Register metadata URL for an account where users will be able to retrieve the metadata file and verify your claims ``` USAGE @@ -922,7 +922,7 @@ FLAGS Ignore metadata validity checks --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d - (required) Addess of the account to set metadata for + (required) Address of the account to set metadata for --gasCurrency=0x1234567890123456789012345678901234567890 Use a specific gas currency for transaction fees (defaults to CELO if no gas @@ -948,7 +948,7 @@ FLAGS (required) The url to the metadata you want to register DESCRIPTION - Register metadata URL for an account where users will be able to retieve the metadata + Register metadata URL for an account where users will be able to retrieve the metadata file and verify your claims EXAMPLES diff --git a/packages/docs/command-line-interface/exchange.md b/packages/docs/command-line-interface/exchange.md index f55782f25..58d997630 100644 --- a/packages/docs/command-line-interface/exchange.md +++ b/packages/docs/command-line-interface/exchange.md @@ -6,7 +6,6 @@ Exchange Celo Dollars and CELO via Mento * [`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) @@ -127,48 +126,6 @@ EXAMPLES _See code: [src/commands/exchange/euros.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/exchange/euros.ts)_ -## `celocli exchange:gold` - -Exchange CELO for StableTokens via the stability mechanism. *DEPRECATION WARNING* Use the "exchange:celo" command instead - -``` -USAGE - $ celocli exchange:gold --from --value [--gasCurrency ] - [--globalHelp] [--forAtLeast ] [--stableToken - cUSD|cusd|cEUR|ceur|cREAL|creal] - -FLAGS - --forAtLeast=10000000000000000000000 [default: 0] Optional, the - minimum value of - StableTokens to receive in - return - --from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address with - CELO to exchange - --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 - --stableToken=