From 54f3ded4e1ada77c80d12148d0e955e9ea7be0d1 Mon Sep 17 00:00:00 2001 From: mfahampshire Date: Tue, 15 Oct 2024 13:50:13 +0200 Subject: [PATCH] updated autogenerated docs --- .../developers/clients/socks5/commands.mdx | 22 +++--- .../developers/clients/websocket/commands.mdx | 22 +++--- .../developers/tools/nym-cli/commands.mdx | 74 +++++++++---------- 3 files changed, 59 insertions(+), 59 deletions(-) diff --git a/documentation/docs/pages/developers/clients/socks5/commands.mdx b/documentation/docs/pages/developers/clients/socks5/commands.mdx index 542ceeeee8..dede24db49 100644 --- a/documentation/docs/pages/developers/clients/socks5/commands.mdx +++ b/documentation/docs/pages/developers/clients/socks5/commands.mdx @@ -1,7 +1,7 @@ # `nym-socks5-client` Binary Commands (Autogenerated) These docs are autogenerated by the `autodocs` script. -``` +```sh A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address Usage: nym-socks5-client [OPTIONS] @@ -27,7 +27,7 @@ Options: ``` ### `init` -``` +```sh Initialise a Nym client. Do this first! Usage: nym-socks5-client init [OPTIONS] --id --provider @@ -73,7 +73,7 @@ Options: ``` ### `run` -``` +```sh Run the Nym client with provided configuration client optionally overriding set parameters Usage: nym-socks5-client run [OPTIONS] --id @@ -109,7 +109,7 @@ Options: ``` ### `import-credential` -``` +```sh Import a pre-generated credential Usage: nym-socks5-client import-credential --id <--credential-data |--credential-path > @@ -126,7 +126,7 @@ Options: ``` ### `list-gateways` -``` +```sh List all registered with gateways Usage: nym-socks5-client list-gateways [OPTIONS] --id @@ -138,7 +138,7 @@ Options: ``` ### `add-gateway` -``` +```sh Add new gateway to this client Usage: nym-socks5-client add-gateway [OPTIONS] --id @@ -155,7 +155,7 @@ Options: ``` ### `build-info` -``` +```sh Show build information of this binary Usage: nym-socks5-client build-info [OPTIONS] @@ -165,7 +165,7 @@ Options: -h, --help Print help ``` Example output: -``` +```sh Binary Name: nym-socks5-client Build Timestamp: 2024-10-09T13:56:14.428750844Z @@ -180,7 +180,7 @@ cargo Profile: release ``` ### `completions` -``` +```sh Generate shell completions Usage: nym-socks5-client completions @@ -193,7 +193,7 @@ Options: ``` ### `generate-fig-spec` -``` +```sh Generate Fig specification Usage: nym-socks5-client generate-fig-spec @@ -202,7 +202,7 @@ Options: -h, --help Print help ``` Example output: -``` +```sh const completion: Fig.Spec = { name: "nym-socks5-client", description: "A SOCKS5 localhost proxy that converts incoming messages to Sphinx and sends them to a Nym address", diff --git a/documentation/docs/pages/developers/clients/websocket/commands.mdx b/documentation/docs/pages/developers/clients/websocket/commands.mdx index 58dc415b2e..89ff4cb724 100644 --- a/documentation/docs/pages/developers/clients/websocket/commands.mdx +++ b/documentation/docs/pages/developers/clients/websocket/commands.mdx @@ -1,7 +1,7 @@ # `nym-client` Binary Commands (Autogenerated) These docs are autogenerated by the `autodocs` script. -``` +```sh Implementation of the Nym Client Usage: nym-client [OPTIONS] @@ -27,7 +27,7 @@ Options: ``` ### `init` -``` +```sh Initialise a Nym client. Do this first! Usage: nym-client init [OPTIONS] --id @@ -56,7 +56,7 @@ Options: ``` ### `run` -``` +```sh Run the Nym client with provided configuration client optionally overriding set parameters Usage: nym-client run [OPTIONS] --id @@ -79,7 +79,7 @@ Options: ``` ### `import-credential` -``` +```sh Import a pre-generated credential Usage: nym-client import-credential --id <--credential-data |--credential-path > @@ -96,7 +96,7 @@ Options: ``` ### `list-gateways` -``` +```sh List all registered with gateways Usage: nym-client list-gateways [OPTIONS] --id @@ -108,7 +108,7 @@ Options: ``` ### `switch-gateway` -``` +```sh Change the currently active gateway. Note that you must have already registered with the new gateway! Usage: nym-client switch-gateway --id --gateway-id @@ -120,7 +120,7 @@ Options: ``` ### `build-info` -``` +```sh Show build information of this binary Usage: nym-client build-info [OPTIONS] @@ -130,7 +130,7 @@ Options: -h, --help Print help ``` Example output: -``` +```sh Binary Name: nym-client Build Timestamp: 2024-10-09T13:56:14.428750844Z @@ -145,7 +145,7 @@ cargo Profile: release ``` ### `completions` -``` +```sh Generate shell completions Usage: nym-client completions @@ -158,7 +158,7 @@ Options: ``` ### `generate-fig-spec` -``` +```sh Generate Fig specification Usage: nym-client generate-fig-spec @@ -167,7 +167,7 @@ Options: -h, --help Print help ``` Example output: -``` +```sh const completion: Fig.Spec = { name: "nym-native-client", description: "Implementation of the Nym Client", diff --git a/documentation/docs/pages/developers/tools/nym-cli/commands.mdx b/documentation/docs/pages/developers/tools/nym-cli/commands.mdx index 8ffad32c23..e6627e3719 100644 --- a/documentation/docs/pages/developers/tools/nym-cli/commands.mdx +++ b/documentation/docs/pages/developers/tools/nym-cli/commands.mdx @@ -1,7 +1,7 @@ # `nym-cli` Binary Commands (Autogenerated) These docs are autogenerated by the `autodocs` script. -``` +```sh A client for interacting with Nym smart contracts and the Nyx blockchain Usage: nym-cli [OPTIONS] @@ -36,7 +36,7 @@ Options: ``` ### `account` -``` +```sh Query and manage Nyx blockchain accounts Usage: nym-cli account [OPTIONS] @@ -68,7 +68,7 @@ Options: ``` ### `account create` -``` +```sh Create a new mnemonic - note, this account does not appear on the chain until the account id is used in a transaction Usage: nym-cli account create [OPTIONS] @@ -93,7 +93,7 @@ Options: ``` ### `account balance` -``` +```sh Gets the balance of an account Usage: nym-cli account balance [OPTIONS] [ADDRESS] @@ -125,7 +125,7 @@ Options: ``` ### `account pub-key` -``` +```sh Gets the public key of an account Usage: nym-cli account pub-key [OPTIONS] [ADDRESS] @@ -153,7 +153,7 @@ Options: ``` ### `account send` -``` +```sh Sends tokens to another account Usage: nym-cli account send [OPTIONS] @@ -184,7 +184,7 @@ Options: ``` ### `account send-multiple` -``` +```sh Batch multiple token sends Usage: nym-cli account send-multiple [OPTIONS] --input @@ -213,7 +213,7 @@ Options: ``` ### `signature` -``` +```sh Sign and verify messages Usage: nym-cli signature [OPTIONS] @@ -242,7 +242,7 @@ Options: ``` ### `signature sign` -``` +```sh Sign a message Usage: nym-cli signature sign [OPTIONS] @@ -268,7 +268,7 @@ Options: ``` ### `signature verify` -``` +```sh Verify a message Usage: nym-cli signature verify [OPTIONS] @@ -296,7 +296,7 @@ Options: ``` ### `ecash` -``` +```sh Ecash related stuff Usage: nym-cli ecash [OPTIONS] @@ -330,7 +330,7 @@ Options: ``` ### `ecash issue-ticket-book` -``` +```sh Usage: nym-cli ecash issue-ticket-book [OPTIONS] <--client-config |--output-file > Options: @@ -367,7 +367,7 @@ Options: ``` ### `ecash recover-ticket-book` -``` +```sh Usage: nym-cli ecash recover-ticket-book [OPTIONS] --client-config Options: @@ -390,7 +390,7 @@ Options: ``` ### `ecash import-ticket-book` -``` +```sh Usage: nym-cli ecash import-ticket-book [OPTIONS] --client-config <--credential-data |--credential-path > <--standalone|--full> Options: @@ -431,7 +431,7 @@ Options: ### `coconut import-credential` ### `block` -``` +```sh Query chain blocks Usage: nym-cli block [OPTIONS] @@ -461,7 +461,7 @@ Options: ``` ### `block get` -``` +```sh Gets a block's details and prints as JSON Usage: nym-cli block get [OPTIONS] @@ -487,7 +487,7 @@ Options: ``` ### `block time` -``` +```sh Gets the block time at a height Usage: nym-cli block time [OPTIONS] @@ -513,7 +513,7 @@ Options: ``` ### `block current-height` -``` +```sh Gets the current block height Usage: nym-cli block current-height [OPTIONS] @@ -536,7 +536,7 @@ Options: ``` ### `cosmwasm` -``` +```sh Manage and execute WASM smart contracts Usage: nym-cli cosmwasm [OPTIONS] @@ -568,7 +568,7 @@ Options: ``` ### `cosmwasm upload` -``` +```sh Upload a smart contract WASM blob Usage: nym-cli cosmwasm upload [OPTIONS] --wasm-path @@ -595,7 +595,7 @@ Options: ``` ### `cosmwasm init` -``` +```sh Init a WASM smart contract Usage: nym-cli cosmwasm init [OPTIONS] --init-message @@ -633,7 +633,7 @@ Options: ``` ### `cosmwasm generate-init-message` -``` +```sh Generate an instantiate message Usage: nym-cli cosmwasm generate-init-message [OPTIONS] @@ -665,7 +665,7 @@ Options: ``` ### `cosmwasm migrate` -``` +```sh Migrate a WASM smart contract Usage: nym-cli cosmwasm migrate [OPTIONS] --code-id @@ -697,7 +697,7 @@ Options: ``` ### `cosmwasm execute` -``` +```sh Execute a WASM smart contract method Usage: nym-cli cosmwasm execute [OPTIONS] [FUNDS] @@ -729,7 +729,7 @@ Options: ``` ### `tx` -``` +```sh Query for transactions Usage: nym-cli tx [OPTIONS] @@ -758,7 +758,7 @@ Options: ``` ### `tx get` -``` +```sh Get a transaction by hash or block height Usage: nym-cli tx get [OPTIONS] @@ -784,7 +784,7 @@ Options: ``` ### `tx query` -``` +```sh Query for transactions Usage: nym-cli tx query [OPTIONS] @@ -810,7 +810,7 @@ Options: ``` ### `vesting-schedule` -``` +```sh Create and query for a vesting schedule Usage: nym-cli vesting-schedule [OPTIONS] @@ -841,7 +841,7 @@ Options: ``` ### `vesting-schedule create` -``` +```sh Creates a vesting schedule Usage: nym-cli vesting-schedule create [OPTIONS] --address
--amount @@ -878,7 +878,7 @@ Options: ``` ### `vesting-schedule query` -``` +```sh Query for vesting schedule Usage: nym-cli vesting-schedule query [OPTIONS] [ADDRESS] @@ -904,7 +904,7 @@ Options: ``` ### `vesting-schedule vested-balance` -``` +```sh Get the amount that has vested and is free for withdrawal, delegation or bonding Usage: nym-cli vesting-schedule vested-balance [OPTIONS] [ADDRESS] @@ -930,7 +930,7 @@ Options: ``` ### `vesting-schedule withdraw-vested` -``` +```sh Withdraw vested tokens (note: the available amount excludes anything delegated or bonded before or after vesting) Usage: nym-cli vesting-schedule withdraw-vested [OPTIONS] @@ -956,7 +956,7 @@ Options: ``` ### `mixnet` -``` +```sh Manage your mixnet infrastructure, delegate stake or query the directory Usage: nym-cli mixnet [OPTIONS] @@ -986,7 +986,7 @@ Options: ``` ### `mixnet query` -``` +```sh Query the mixnet directory Usage: nym-cli mixnet query [OPTIONS] @@ -1015,7 +1015,7 @@ Options: ``` ### `mixnet delegators` -``` +```sh Manage your delegations Usage: nym-cli mixnet delegators [OPTIONS] @@ -1050,7 +1050,7 @@ Options: ``` ### `mixnet operators` -``` +```sh Manage a mixnode or gateway you operate Usage: nym-cli mixnet operators [OPTIONS] @@ -1080,7 +1080,7 @@ Options: ``` ### `generate-fig` -``` +```sh Generates shell completion Usage: nym-cli generate-fig [OPTIONS]