Skip to content

Commit

Permalink
fixes in the node command guide, added more commands (#879)
Browse files Browse the repository at this point in the history
* fixes in the node command guide, added more commands

* fixed a typo
  • Loading branch information
ijonele authored Sep 20, 2024
1 parent 6d14112 commit 78301ea
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ wardend keys add my-key-name
Alternatively, you can restore an existing wallet with a mnemonic seed phrase. Replace `my-key-name` with a key name of your choice and run the following:

```bash
wardend keys add my-key-name --recover.
wardend keys add my-key-name --recover
```

Then get your public address:
Expand Down
35 changes: 23 additions & 12 deletions docs/developer-docs/docs/operate-a-node/node-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,13 @@ To interact with the node, you need to install the [Warden binary](https://githu

## Execute `wardend` commands

To execute a node command, just run `wardend`, followed by the command. Include the `--node` flag with the node endpoint.
To execute a node command, just run `wardend`, followed by the command. If you need to specify a node to interact with, include the `--node` flag with the node endpoint.

For example, to check the node status, run the example below, using the preferred endpoint.
For example, to check the node status, run the example below using the preferred endpoint:

```bash
wardend status --node https://rpc.buenavista.wardenprotocol.org:443
wardend status \
--node https://rpc.buenavista.wardenprotocol.org:443
```

:::tip
Expand Down Expand Up @@ -73,13 +74,15 @@ Here are some of the available `wardend query warden` subcommands with examples:
- `keychains`: This command returns a list of your [Keychains](/learn/glossary#keychain).

```bash
wardend query warden keychains --node https://rpc.buenavista.wardenprotocol.org:443
wardend query warden keychains \
--node https://rpc.buenavista.wardenprotocol.org:443
```

- `spaces`: This command returns a list of your [Spaces](/learn/glossary#space).

```bash
wardend query warden spaces --node https://rpc.buenavista.wardenprotocol.org:443
wardend query warden spaces\
--node https://rpc.buenavista.wardenprotocol.org:443
```

### `keys`: Manage keys
Expand All @@ -95,25 +98,33 @@ Here are some examples of `wardend keys` commands:
- `list`: This command returns a list of your keys.

```bash
wardend keys list --node https://rpc.buenavista.wardenprotocol.org:443
wardend keys list
```

- `add`: This command adds a key – you executed it when setting up your node. It requires specifying an arbitrary key name.
- `add`: This command adds a key, either newly generated or recovered.

To create a new key, you need to specify its name:

```bash
wardend keys add my-key-name --node https://rpc.buenavista.wardenprotocol.org:443
wardend keys add my-key-name
```

To restore a key from its seed phrase, add the `--recover` flag:

```bash
wardend keys add my-key-name --recover
```

- `delete`: This command deletes a key, identified by its name.

```bash
wardend keys delete my-key-name --node https://rpc.buenavista.wardenprotocol.org:443
wardend keys delete my-key-name
```

- `add-keychain-writer`: This command adds a new [Keychain Writer](/learn/glossary#keychain-writer). It requires specifying an arbitrary Keychain Writer name.
- `show`: This command returns key information. For example, you can get the key address by its name:

```bash
wardend keys add my-keychain-writer-name --node https://rpc.buenavista.wardenprotocol.org:443
wardend keys show my-key-name --address
```

### `tx`: Initiate transactions
Expand Down

0 comments on commit 78301ea

Please sign in to comment.