generated from okp4/template-oss
-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #441 from okp4/docs/commands-v7.0.0
📜 Add v7.0.0 commands documentation version
- Loading branch information
Showing
387 changed files
with
13,256 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
## okp4d | ||
|
||
OKP4 Daemon 👹 | ||
|
||
### Synopsis | ||
|
||
OKP4 Daemon 👹 - a revolutionary public PoS layer 1 specifically designed to enable communities to trustlessly share data, | ||
algorithms and resources to build the Dataverse! | ||
|
||
Want to lean more about OKP4 network? Complete documentation is available at [https://docs.okp4.network](https://docs.okp4.network) 👀 | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for okp4d | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d comet](okp4d_comet.md) - CometBFT subcommands | ||
* [okp4d config](okp4d_config.md) - Utilities for managing application configuration | ||
* [okp4d credential](okp4d_credential.md) - W3C Verifiable Credential | ||
* [okp4d debug](okp4d_debug.md) - Tool for helping with debugging your application | ||
* [okp4d export](okp4d_export.md) - Export state to JSON | ||
* [okp4d genesis](okp4d_genesis.md) - Application's genesis-related subcommands | ||
* [okp4d init](okp4d_init.md) - Initialize private validator, p2p, genesis, and application configuration files | ||
* [okp4d keys](okp4d_keys.md) - Manage your application's keys | ||
* [okp4d prune](okp4d_prune.md) - Prune app history states by keeping the recent heights and deleting old heights | ||
* [okp4d query](okp4d_query.md) - Querying subcommands | ||
* [okp4d rollback](okp4d_rollback.md) - rollback Cosmos SDK and CometBFT state by one height | ||
* [okp4d snapshots](okp4d_snapshots.md) - Manage local snapshots | ||
* [okp4d start](okp4d_start.md) - Run the full node | ||
* [okp4d status](okp4d_status.md) - Query remote node for status | ||
* [okp4d tx](okp4d_tx.md) - Transactions subcommands | ||
* [okp4d version](okp4d_version.md) - Print the application binary version information |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## okp4d comet | ||
|
||
CometBFT subcommands | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for comet | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d](okp4d.md) - OKP4 Daemon 👹 | ||
* [okp4d comet bootstrap-state](okp4d_comet_bootstrap-state.md) - Bootstrap CometBFT state at an arbitrary block height using a light client | ||
* [okp4d comet reset-state](okp4d_comet_reset-state.md) - Remove all the data and WAL | ||
* [okp4d comet show-address](okp4d_comet_show-address.md) - Shows this node's CometBFT validator consensus address | ||
* [okp4d comet show-node-id](okp4d_comet_show-node-id.md) - Show this node's ID | ||
* [okp4d comet show-validator](okp4d_comet_show-validator.md) - Show this node's CometBFT validator info | ||
* [okp4d comet unsafe-reset-all](okp4d_comet_unsafe-reset-all.md) - (unsafe) Remove all the data and WAL, reset this node's validator to genesis state | ||
* [okp4d comet version](okp4d_comet_version.md) - Print CometBFT libraries' version |
18 changes: 18 additions & 0 deletions
18
commands_versioned_docs/version-v7.0.0/okp4d_comet_bootstrap-state.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
## okp4d comet bootstrap-state | ||
|
||
Bootstrap CometBFT state at an arbitrary block height using a light client | ||
|
||
``` | ||
okp4d comet bootstrap-state [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--height int Block height to bootstrap state at, if not provided it uses the latest block height in app state | ||
-h, --help help for bootstrap-state | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d comet](okp4d_comet.md) - CometBFT subcommands |
17 changes: 17 additions & 0 deletions
17
commands_versioned_docs/version-v7.0.0/okp4d_comet_reset-state.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## okp4d comet reset-state | ||
|
||
Remove all the data and WAL | ||
|
||
``` | ||
okp4d comet reset-state [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for reset-state | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d comet](okp4d_comet.md) - CometBFT subcommands |
17 changes: 17 additions & 0 deletions
17
commands_versioned_docs/version-v7.0.0/okp4d_comet_show-address.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## okp4d comet show-address | ||
|
||
Shows this node's CometBFT validator consensus address | ||
|
||
``` | ||
okp4d comet show-address [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for show-address | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d comet](okp4d_comet.md) - CometBFT subcommands |
17 changes: 17 additions & 0 deletions
17
commands_versioned_docs/version-v7.0.0/okp4d_comet_show-node-id.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## okp4d comet show-node-id | ||
|
||
Show this node's ID | ||
|
||
``` | ||
okp4d comet show-node-id [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for show-node-id | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d comet](okp4d_comet.md) - CometBFT subcommands |
17 changes: 17 additions & 0 deletions
17
commands_versioned_docs/version-v7.0.0/okp4d_comet_show-validator.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## okp4d comet show-validator | ||
|
||
Show this node's CometBFT validator info | ||
|
||
``` | ||
okp4d comet show-validator [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for show-validator | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d comet](okp4d_comet.md) - CometBFT subcommands |
18 changes: 18 additions & 0 deletions
18
commands_versioned_docs/version-v7.0.0/okp4d_comet_unsafe-reset-all.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
## okp4d comet unsafe-reset-all | ||
|
||
(unsafe) Remove all the data and WAL, reset this node's validator to genesis state | ||
|
||
``` | ||
okp4d comet unsafe-reset-all [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for unsafe-reset-all | ||
--keep-addr-book keep the address book intact | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d comet](okp4d_comet.md) - CometBFT subcommands |
21 changes: 21 additions & 0 deletions
21
commands_versioned_docs/version-v7.0.0/okp4d_comet_version.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## okp4d comet version | ||
|
||
Print CometBFT libraries' version | ||
|
||
### Synopsis | ||
|
||
Print protocols' and libraries' version numbers against which this app has been compiled. | ||
|
||
``` | ||
okp4d comet version [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for version | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d comet](okp4d_comet.md) - CometBFT subcommands |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## okp4d config | ||
|
||
Utilities for managing application configuration | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for config | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d](okp4d.md) - OKP4 Daemon 👹 | ||
* [okp4d config diff](okp4d_config_diff.md) - Outputs all config values that are different from the app.toml defaults. | ||
* [okp4d config get](okp4d_config_get.md) - Get an application config value | ||
* [okp4d config home](okp4d_config_home.md) - Outputs the folder used as the binary home. No home directory is set when using the tool standalone. | ||
* [okp4d config migrate](okp4d_config_migrate.md) - Migrate Cosmos SDK app configuration file to the specified version | ||
* [okp4d config set](okp4d_config_set.md) - Set an application config value | ||
* [okp4d config view](okp4d_config_view.md) - View the config file |
17 changes: 17 additions & 0 deletions
17
commands_versioned_docs/version-v7.0.0/okp4d_config_diff.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
## okp4d config diff | ||
|
||
Outputs all config values that are different from the app.toml defaults. | ||
|
||
``` | ||
okp4d config diff [target-version] <app-toml-path> [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for diff | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d config](okp4d_config.md) - Utilities for managing application configuration |
21 changes: 21 additions & 0 deletions
21
commands_versioned_docs/version-v7.0.0/okp4d_config_get.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## okp4d config get | ||
|
||
Get an application config value | ||
|
||
### Synopsis | ||
|
||
Get an application config value. The [config] argument must be the path of the file when using the too standalone, otherwise it must be the name of the config file without the .toml extension. | ||
|
||
``` | ||
okp4d config get [config] [key] [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for get | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d config](okp4d_config.md) - Utilities for managing application configuration |
21 changes: 21 additions & 0 deletions
21
commands_versioned_docs/version-v7.0.0/okp4d_config_home.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
## okp4d config home | ||
|
||
Outputs the folder used as the binary home. No home directory is set when using the tool standalone. | ||
|
||
### Synopsis | ||
|
||
Outputs the folder used as the binary home. In order to change the home directory path, set the $APPD_HOME environment variable, or use the "--home" flag. | ||
|
||
``` | ||
okp4d config home [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for home | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d config](okp4d_config.md) - Utilities for managing application configuration |
26 changes: 26 additions & 0 deletions
26
commands_versioned_docs/version-v7.0.0/okp4d_config_migrate.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
## okp4d config migrate | ||
|
||
Migrate Cosmos SDK app configuration file to the specified version | ||
|
||
### Synopsis | ||
|
||
Migrate the contents of the Cosmos SDK app configuration (app.toml) to the specified version. | ||
The output is written in-place unless --stdout is provided. | ||
In case of any error in updating the file, no output is written. | ||
|
||
``` | ||
okp4d config migrate [target-version] <app-toml-path> (options) [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for migrate | ||
--skip-validate skip configuration validation (allows to migrate unknown configurations) | ||
--stdout print the updated config to stdout | ||
--verbose log changes to stderr | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d config](okp4d_config.md) - Utilities for managing application configuration |
24 changes: 24 additions & 0 deletions
24
commands_versioned_docs/version-v7.0.0/okp4d_config_set.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
## okp4d config set | ||
|
||
Set an application config value | ||
|
||
### Synopsis | ||
|
||
Set an application config value. The [config] argument must be the path of the file when using the tool standalone, otherwise it must be the name of the config file without the .toml extension. | ||
|
||
``` | ||
okp4d config set [config] [key] [value] [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for set | ||
-s, --skip-validate skip configuration validation (allows to mutate unknown configurations) | ||
--stdout print the updated config to stdout | ||
-v, --verbose log changes to stderr | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d config](okp4d_config.md) - Utilities for managing application configuration |
18 changes: 18 additions & 0 deletions
18
commands_versioned_docs/version-v7.0.0/okp4d_config_view.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
## okp4d config view | ||
|
||
View the config file | ||
|
||
``` | ||
okp4d config view [config] [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for view | ||
--output-format string Output format (json|toml) (default "toml") | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d config](okp4d_config.md) - Utilities for managing application configuration |
20 changes: 20 additions & 0 deletions
20
commands_versioned_docs/version-v7.0.0/okp4d_credential.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
## okp4d credential | ||
|
||
W3C Verifiable Credential | ||
|
||
### Synopsis | ||
|
||
W3C Verifiable Credentials management commands. | ||
|
||
This command provides a set of sub-commands to manage W3C Verifiable Credentials, including signing and verification operations. | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for credential | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d](okp4d.md) - OKP4 Daemon 👹 | ||
* [okp4d credential sign](okp4d_credential_sign.md) - Sign a W3C Verifiable Credential provided as a file or stdin |
29 changes: 29 additions & 0 deletions
29
commands_versioned_docs/version-v7.0.0/okp4d_credential_sign.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
## okp4d credential sign | ||
|
||
Sign a W3C Verifiable Credential provided as a file or stdin | ||
|
||
### Synopsis | ||
|
||
Sign a W3C Verifiable Credential; | ||
|
||
It will read a verifiable credential from a file (or stdin), sign it, and print the JSON-LD signed credential to stdout. | ||
|
||
``` | ||
okp4d credential sign [file] [flags] | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
--date string Date of the signature provided in RFC3339 format. If not provided, current time will be used | ||
--from string Name or address of private key with which to sign | ||
-h, --help help for sign | ||
--keyring-backend string Select keyring's backend (os|file|kwallet|pass|test|memory) (default "test") | ||
--keyring-dir string The client Keyring directory; if omitted, the default 'home' directory will be used | ||
--overwrite Overwrite existing signatures with a new one. If disabled, new signature will be appended | ||
--schema-map strings Map original URIs to alternative URIs for resolving JSON-LD schemas. Useful for redirecting network-based URIs to local filesystem paths or other URIs. Each mapping should be in the format 'originalURI=alternativeURI'. Multiple mappings can be provided by repeating the flag. Example usage: --schema-map originalURI1=alternativeURI1 --schema-map originalURI2=alternativeURI2 | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [okp4d credential](okp4d_credential.md) - W3C Verifiable Credential |
Oops, something went wrong.