GRIN/nym
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Max/individual command autodocs (#5018)

Browse Source 
* updated autodoc script

* updated autodoc script for fix + reintroduced gitignore file for generated markdown

* auto commit generated command files

* auto commit generated command files

* added command-outputs to autodoc script

* fix merge conflicts

* repush components
This commit is contained in:
mx
2024-10-23 08:55:42 +00:00
committed by mfahampshire
parent c1659a235e
commit bf05930fa8
33 changed files with 496 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/docs/pages/developers/clients/socks5/commands.mdx
+3 -3
View File
@@ -168,10 +168,10 @@ Example output:
```sh
Binary Name: nym-socks5-client
Build Timestamp: 2024-10-22T15:51:54.341993905Z
Build Timestamp: 2024-10-23T08:50:32.539144092Z
Build Version: 1.1.39
Commit SHA: 0e7bbbf93b909bbf3fecd594213bc9b92aec24f1
Commit Date: 2024-10-22T17:18:51.000000000+02:00
Commit SHA: b960cbd978b9ffa17c884bce22f0e59c20b9aa01
Commit Date: 2024-10-23T10:49:01.000000000+02:00
Commit Branch: max/individual-command-autodocs
rustc Version: 1.80.0
rustc Channel: stable
documentation/docs/pages/developers/clients/websocket/commands.mdx
+3 -3
View File
@@ -133,10 +133,10 @@ Example output:
```sh
Binary Name: nym-client
Build Timestamp: 2024-10-22T15:51:54.341993905Z
Build Timestamp: 2024-10-23T08:50:32.539144092Z
Build Version: 1.1.39
Commit SHA: 0e7bbbf93b909bbf3fecd594213bc9b92aec24f1
Commit Date: 2024-10-22T17:18:51.000000000+02:00
Commit SHA: b960cbd978b9ffa17c884bce22f0e59c20b9aa01
Commit Date: 2024-10-23T10:49:01.000000000+02:00
Commit Branch: max/individual-command-autodocs
rustc Version: 1.80.0
rustc Channel: stable
documentation/docs/pages/developers/tools/nym-cli/commands.mdx
+6 -26
View File
@@ -303,14 +303,10 @@ Usage: nym-cli ecash [OPTIONS]
nym-cli ecash <COMMAND>
Commands:
issue-ticket-book
recover-ticket-book
import-ticket-book
generate-ticket
import-coin-index-signatures
import-expiration-date-signatures
import-master-verification-key
help Print this message or the help of the given subcommand(s)
issue-ticket-book
recover-ticket-book
import-ticket-book
help Print this message or the help of the given subcommand(s)
Options:
--mnemonic <MNEMONIC>
@@ -331,7 +327,7 @@ Options:
### `ecash issue-ticket-book`
```sh
Usage: nym-cli ecash issue-ticket-book [OPTIONS] <--client-config <CLIENT_CONFIG>|--output-file <OUTPUT_FILE>>
Usage: nym-cli ecash issue-ticket-book [OPTIONS] --client-config <CLIENT_CONFIG>
Options:
--mnemonic <MNEMONIC>
@@ -344,24 +340,12 @@ Options:
Config file of the client that is supposed to use the credential
--nyxd-url <NYXD_URL>
Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file
--output-file <OUTPUT_FILE>
Output file for the ticketbook
--bs58-output
Specifies whether the output file should use binary or bs58 encoded data
--nym-api-url <NYM_API_URL>
Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file
--include-expiration-date-signatures
Specifies whether the file output should contain expiration date signatures
--mixnet-contract-address <MIXNET_CONTRACT_ADDRESS>
Overrides the mixnet contract address provided either as an environment variable or in a config file
--include-coin-index-signatures
Specifies whether the file output should contain coin index signatures
--vesting-contract-address <VESTING_CONTRACT_ADDRESS>
Overrides the vesting contract address provided either as an environment variable or in a config file
--include-master-verification-key
Specifies whether the file output should contain master verification key
--bs58-encoded-client-secret <BS58_ENCODED_CLIENT_SECRET>
Secret value that's used for deriving underlying ecash keypair
-h, --help
Print help
```
@@ -391,7 +375,7 @@ Options:
### `ecash import-ticket-book`
```sh
Usage: nym-cli ecash import-ticket-book [OPTIONS] --client-config <CLIENT_CONFIG> <--credential-data <CREDENTIAL_DATA>|--credential-path <CREDENTIAL_PATH>> <--standalone|--full>
Usage: nym-cli ecash import-ticket-book [OPTIONS] --client-config <CLIENT_CONFIG> <--credential-data <CREDENTIAL_DATA>|--credential-path <CREDENTIAL_PATH>>
Options:
--client-config <CLIENT_CONFIG>
@@ -408,10 +392,6 @@ Options:
Overrides the nyxd URL provided either as an environment variable NYXD_VALIDATOR or in a config file
--nym-api-url <NYM_API_URL>
Overrides the validator API URL provided either as an environment variable API_VALIDATOR or in a config file
--standalone
Specifies whether we're attempting to import a standalone ticketbook (i.e. serialised `IssuedTicketBook`)
--full
Specifies whether we're attempting to import full ticketboot (i.e. one that **might** contain required global signatures; that is serialised `ImportableTicketBook`)
--mixnet-contract-address <MIXNET_CONTRACT_ADDRESS>
Overrides the mixnet contract address provided either as an environment variable or in a config file
--vesting-contract-address <VESTING_CONTRACT_ADDRESS>