Skip to content

Commit

Permalink
feat(commands): add axone-protocol/axoned v10.0.0 commands documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bot-anik committed Aug 29, 2024
1 parent 3695fe1 commit 3982fab
Show file tree
Hide file tree
Showing 394 changed files with 13,529 additions and 0 deletions.
36 changes: 36 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## axoned

Axone - Orchestration Layer for AI

### Synopsis

Axone is a public dPoS layer 1 specifically designed for connecting, sharing, and monetizing any resources in the AI stack.
It is an open network dedicated to collaborative AI workflow management that is universally compatible with any data, model,
or infrastructure. Data, algorithms, storage, compute, APIs... Anything on-chain and off-chain can be shared.

Want to lean more about AXONE network? Complete documentation is available at: [https://docs.axone.xyz](https://docs.axone.xyz) 👀

### Options

```
-h, --help help for axoned
```

### SEE ALSO

* [axoned comet](axoned_comet.md) - CometBFT subcommands
* [axoned config](axoned_config.md) - Utilities for managing application configuration
* [axoned credential](axoned_credential.md) - W3C Verifiable Credential
* [axoned debug](axoned_debug.md) - Tool for helping with debugging your application
* [axoned export](axoned_export.md) - Export state to JSON
* [axoned genesis](axoned_genesis.md) - Application's genesis-related subcommands
* [axoned init](axoned_init.md) - Initialize private validator, p2p, genesis, and application configuration files
* [axoned keys](axoned_keys.md) - Manage your application's keys
* [axoned prune](axoned_prune.md) - Prune app history states by keeping the recent heights and deleting old heights
* [axoned query](axoned_query.md) - Querying subcommands
* [axoned rollback](axoned_rollback.md) - rollback Cosmos SDK and CometBFT state by one height
* [axoned snapshots](axoned_snapshots.md) - Manage local snapshots
* [axoned start](axoned_start.md) - Run the full node
* [axoned status](axoned_status.md) - Query remote node for status
* [axoned tx](axoned_tx.md) - Transactions subcommands
* [axoned version](axoned_version.md) - Print the application binary version information
20 changes: 20 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_comet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## axoned comet

CometBFT subcommands

### Options

```
-h, --help help for comet
```

### SEE ALSO

* [axoned](axoned.md) - Axone - Orchestration Layer for AI
* [axoned comet bootstrap-state](axoned_comet_bootstrap-state.md) - Bootstrap CometBFT state at an arbitrary block height using a light client
* [axoned comet reset-state](axoned_comet_reset-state.md) - Remove all the data and WAL
* [axoned comet show-address](axoned_comet_show-address.md) - Shows this node's CometBFT validator consensus address
* [axoned comet show-node-id](axoned_comet_show-node-id.md) - Show this node's ID
* [axoned comet show-validator](axoned_comet_show-validator.md) - Show this node's CometBFT validator info
* [axoned comet unsafe-reset-all](axoned_comet_unsafe-reset-all.md) - (unsafe) Remove all the data and WAL, reset this node's validator to genesis state
* [axoned comet version](axoned_comet_version.md) - Print CometBFT libraries' version
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## axoned comet bootstrap-state

Bootstrap CometBFT state at an arbitrary block height using a light client

```
axoned 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

* [axoned comet](axoned_comet.md) - CometBFT subcommands
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## axoned comet reset-state

Remove all the data and WAL

```
axoned comet reset-state [flags]
```

### Options

```
-h, --help help for reset-state
```

### SEE ALSO

* [axoned comet](axoned_comet.md) - CometBFT subcommands
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## axoned comet show-address

Shows this node's CometBFT validator consensus address

```
axoned comet show-address [flags]
```

### Options

```
-h, --help help for show-address
```

### SEE ALSO

* [axoned comet](axoned_comet.md) - CometBFT subcommands
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## axoned comet show-node-id

Show this node's ID

```
axoned comet show-node-id [flags]
```

### Options

```
-h, --help help for show-node-id
```

### SEE ALSO

* [axoned comet](axoned_comet.md) - CometBFT subcommands
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## axoned comet show-validator

Show this node's CometBFT validator info

```
axoned comet show-validator [flags]
```

### Options

```
-h, --help help for show-validator
```

### SEE ALSO

* [axoned comet](axoned_comet.md) - CometBFT subcommands
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## axoned comet unsafe-reset-all

(unsafe) Remove all the data and WAL, reset this node's validator to genesis state

```
axoned comet unsafe-reset-all [flags]
```

### Options

```
-h, --help help for unsafe-reset-all
--keep-addr-book keep the address book intact
```

### SEE ALSO

* [axoned comet](axoned_comet.md) - CometBFT subcommands
21 changes: 21 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_comet_version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## axoned comet version

Print CometBFT libraries' version

### Synopsis

Print protocols' and libraries' version numbers against which this app has been compiled.

```
axoned comet version [flags]
```

### Options

```
-h, --help help for version
```

### SEE ALSO

* [axoned comet](axoned_comet.md) - CometBFT subcommands
19 changes: 19 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## axoned config

Utilities for managing application configuration

### Options

```
-h, --help help for config
```

### SEE ALSO

* [axoned](axoned.md) - Axone - Orchestration Layer for AI
* [axoned config diff](axoned_config_diff.md) - Outputs all config values that are different from the app.toml defaults.
* [axoned config get](axoned_config_get.md) - Get an application config value
* [axoned config home](axoned_config_home.md) - Outputs the folder used as the binary home. No home directory is set when using the `confix` tool standalone.
* [axoned config migrate](axoned_config_migrate.md) - Migrate Cosmos SDK app configuration file to the specified version
* [axoned config set](axoned_config_set.md) - Set an application config value
* [axoned config view](axoned_config_view.md) - View the config file
17 changes: 17 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_config_diff.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## axoned config diff

Outputs all config values that are different from the app.toml defaults.

```
axoned config diff [target-version] <app-toml-path> [flags]
```

### Options

```
-h, --help help for diff
```

### SEE ALSO

* [axoned config](axoned_config.md) - Utilities for managing application configuration
21 changes: 21 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_config_get.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## axoned 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 `confix` tool standalone, otherwise it must be the name of the config file without the .toml extension.

```
axoned config get [config] [key] [flags]
```

### Options

```
-h, --help help for get
```

### SEE ALSO

* [axoned config](axoned_config.md) - Utilities for managing application configuration
21 changes: 21 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_config_home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## axoned config home

Outputs the folder used as the binary home. No home directory is set when using the `confix` 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.

```
axoned config home [flags]
```

### Options

```
-h, --help help for home
```

### SEE ALSO

* [axoned config](axoned_config.md) - Utilities for managing application configuration
26 changes: 26 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_config_migrate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## axoned 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.

```
axoned 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

* [axoned config](axoned_config.md) - Utilities for managing application configuration
24 changes: 24 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_config_set.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## axoned 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 `confix` tool standalone, otherwise it must be the name of the config file without the .toml extension.

```
axoned 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

* [axoned config](axoned_config.md) - Utilities for managing application configuration
22 changes: 22 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_config_view.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## axoned config view

View the config file

### Synopsis

View the config file. The [config] argument must be the path of the file when using the `confix` tool standalone, otherwise it must be the name of the config file without the .toml extension.

```
axoned config view [config] [flags]
```

### Options

```
-h, --help help for view
--output-format string Output format (json|toml) (default "toml")
```

### SEE ALSO

* [axoned config](axoned_config.md) - Utilities for managing application configuration
20 changes: 20 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_credential.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## axoned 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

* [axoned](axoned.md) - Axone - Orchestration Layer for AI
* [axoned credential sign](axoned_credential_sign.md) - Sign a W3C Verifiable Credential provided as a file or stdin
30 changes: 30 additions & 0 deletions commands_versioned_docs/version-v10.0.0/axoned_credential_sign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## axoned 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.

```
axoned 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
--purpose string Proof that describes credential purpose, helps prevent it from being misused for some other purpose. Example of commonly used proof purpose values: authentication, assertionMethod, keyAgreement, capabilityDelegation, capabilityInvocation. (default "assertionMethod")
--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

* [axoned credential](axoned_credential.md) - W3C Verifiable Credential
Loading

0 comments on commit 3982fab

Please sign in to comment.