Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

# UNRELEASED

## Fixes

### fix: fix formatting and broken anchors in CLI reference documentation

Fixed incorrect page title in `dfx-killall.mdx`, broken anchor references in command tables for `dfx cache`, `dfx nns`, and `dfx sns`, malformed markdown tables in `dfx-wallet.mdx`, `dfx-cycles.mdx`, and `dfx-completion.mdx`, and a missing code block language tag in `dfx-sns.mdx`.

## Dependencies

### Motoko
Expand Down
4 changes: 2 additions & 2 deletions docs/cli-reference/dfx-cache.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Depending on the `dfx cache` subcommand you specify, additional arguments, optio
| [`delete`](#delete) | Deletes the specified version of `dfx` from the local cache. |
| `help` | Displays usage information message for the `dfx cache` command. |
| [`install`](#install) | Installs the specified version of `dfx` from the local cache. |
| [`list`](#_dfx_cache_list) | Lists the versions of `dfx` currently installed and used in current projects. |
| [`show`](#_dfx_cache_show) | Show the path of the cache used by this version of the `dfx` executable. |
| [`list`](#dfx-cache-list) | Lists the versions of `dfx` currently installed and used in current projects. |
| [`show`](#dfx-cache-show) | Show the path of the cache used by this version of the `dfx` executable. |

To view usage information for a specific subcommand, specify the subcommand and the `--help` flag. For example, to see usage information for `dfx cache delete`, you can run the following command:

Expand Down
2 changes: 1 addition & 1 deletion docs/cli-reference/dfx-completion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ and `zsh`. The default value is `bash`.

You can use the following option with the `dfx completion` command.

| Option | Description -|
| Option | Description |
|-----------------------|-------------------------------------|
| `--bin-name <name>` | Name of the command. Only needed if referring to `dfx` by another name, such as with an alias. Default `dfx`. |

Expand Down
6 changes: 3 additions & 3 deletions docs/cli-reference/dfx-cycles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -217,9 +217,9 @@ dfx cycles redeem-faucet-coupon <your faucet coupon>
Use the following necessary argument with the `dfx cycles redeem-faucet-coupon` command.


|Argument |Description
----------|--------------
|`<your faucet coupon>` | The coupon code to redeem at the faucet.|
| Argument | Description |
|----------|-------------|
| `<your faucet coupon>` | The coupon code to redeem at the faucet. |


### Flags
Expand Down
2 changes: 1 addition & 1 deletion docs/cli-reference/dfx-killall.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { MarkdownChipRow } from "/src/components/Chip/MarkdownChipRow";

# dfx stop
# dfx killall

<MarkdownChipRow labels={["Reference"]} />

Expand Down
6 changes: 3 additions & 3 deletions docs/cli-reference/dfx-nns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ Depending on the `dfx nns` subcommand you specify, additional arguments, options

| Command | Description |
|-------------------------------------|-------------------------------------------------------------------------------|
| [`import`](#_dfx_nns_import) | Adds the NNS canisters to the local `dfx.json` as remote canisters. |
| [`install`](#_dfx_nns_install) | Deploys NNS canisters to the local development environment. |
| [`import`](#dfx-nns-import) | Adds the NNS canisters to the local `dfx.json` as remote canisters. |
| [`install`](#dfx-nns-install) | Deploys NNS canisters to the local development environment. |
| `help` | Displays usage information message for a specified subcommand. |

To view usage information for a specific subcommand, specify the subcommand and the `--help` flag. For example, to see usage information for `dfx nns install`, you can run the following command:
Expand Down Expand Up @@ -125,7 +125,7 @@ Two accounts in the local ledger is initialized with ICP that can be used for te

To use ICP on the command line:

1. Start `dfx` and install the NNS, as described in [`install`](#_dfx_nns_install).
1. Start `dfx` and install the NNS, as described in [`install`](#dfx-nns-install).

2. Put this secret key into a file called `ident-1.pem`:

Expand Down
8 changes: 4 additions & 4 deletions docs/cli-reference/dfx-sns.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Depending on the `dfx sns` subcommand you specify, additional arguments, options

| Command | Description |
|-------------------------------------|-------------------------------------------------------------------------------|
| [`create`](#_dfx_sns_create) | Creates an SNS configuration template. |
| [`validate`](#_dfx_sns_validate) | Checks whether the sns config file is valid. |
| [`deploy`](#_dfx_sns_deploy) | Deploys SNS canisters according to the local config. |
| [`create`](#dfx-sns-create) | Creates an SNS configuration template. |
| [`validate`](#dfx-sns-validate) | Checks whether the sns config file is valid. |
| [`deploy`](#dfx-sns-deploy) | Deploys SNS canisters according to the local config. |
| `help` | Displays usage information message for a specified subcommand. |

To view usage information for a specific subcommand, specify the subcommand and the `--help` flag. For example, to see usage information for `dfx sns validate`, you can run the following command:
Expand Down Expand Up @@ -104,7 +104,7 @@ dfx sns deploy

You can now verify that the sns canisters have been created.

```
``` bash
dfx canister info sns_root
dfx canister info sns_ledger
```
Expand Down
80 changes: 40 additions & 40 deletions docs/cli-reference/dfx-wallet.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,21 @@ dfx wallet send --help
For reference information and examples that illustrate using `dfx wallet` commands, select an appropriate command.


|Command |Description
---------|-----------------------------------
|[`add-controller`](#dfx-wallet-add-controller) | Add a controller using the selected identity's principal. |
|[`addresses`](#dfx-wallet-addresses)|Displays the address book of the cycles wallet.|
|[`authorize`](#dfx-wallet-authorize)|Authorize a custodian by principal for the selected identity's cycles wallet.|
|[`balance`](#dfx-wallet-balance)|Displays the cycles wallet balance of the selected identity.
|[`controllers`](#dfx-wallet-controllers) |Displays a list of the selected identity's cycles wallet controllers.
|[`custodians`](#dfx-wallet-custodians) |Displays a list of the selected identity's cycles wallet custodians.
|[`deauthorize`](#dfx-wallet-deauthorize) | Deauthorize a cycles wallet custodian using the custodian's principal.
|`help`|Displays a usage message and the help info for the given subcommand(s).
|[`name`](#dfx-wallet-name) |Returns the name of the cycles wallet if you've used the `dfx wallet set-name` command.
|[`remove-controller`](#dfx-wallet-remove-controller) |Removes a specified controller from the selected identity's cycles wallet.
|[`send`](#dfx-wallet-send) |Sends a specified amount of cycles from the selected identity's cycles wallet to another canister.
|[`set-name`](#dfx-wallet-set-name) |Specify a name for your cycles wallet.
|[`upgrade`](#dfx-wallet-upgrade) |Upgrade the cycles wallet's Wasm module to the current Wasm bundled with `dfx`.
| Command | Description |
|---------|-------------|
| [`add-controller`](#dfx-wallet-add-controller) | Add a controller using the selected identity's principal. |
| [`addresses`](#dfx-wallet-addresses) | Displays the address book of the cycles wallet. |
| [`authorize`](#dfx-wallet-authorize) | Authorize a custodian by principal for the selected identity's cycles wallet. |
| [`balance`](#dfx-wallet-balance) | Displays the cycles wallet balance of the selected identity. |
| [`controllers`](#dfx-wallet-controllers) | Displays a list of the selected identity's cycles wallet controllers. |
| [`custodians`](#dfx-wallet-custodians) | Displays a list of the selected identity's cycles wallet custodians. |
| [`deauthorize`](#dfx-wallet-deauthorize) | Deauthorize a cycles wallet custodian using the custodian's principal. |
| `help` | Displays a usage message and the help info for the given subcommand(s). |
| [`name`](#dfx-wallet-name) | Returns the name of the cycles wallet if you've used the `dfx wallet set-name` command. |
| [`remove-controller`](#dfx-wallet-remove-controller) | Removes a specified controller from the selected identity's cycles wallet. |
| [`send`](#dfx-wallet-send) | Sends a specified amount of cycles from the selected identity's cycles wallet to another canister. |
| [`set-name`](#dfx-wallet-set-name) | Specify a name for your cycles wallet. |
| [`upgrade`](#dfx-wallet-upgrade) | Upgrade the cycles wallet's Wasm module to the current Wasm bundled with `dfx`. |


## Using your wallet
Expand Down Expand Up @@ -80,18 +80,18 @@ dfx wallet add-controller [option] <controller> [flag]
You can use the following options with the `dfx canister call` command.


|Option |Description|
--------|------------|
|`--network` |Override the environment to connect to. By default, the local development environment is used. A valid URL (starting with `http:` or `https:`) can be specified here, e.g. "http://localhost:12345/" is a valid network name.
| Option | Description |
|--------|-------------|
| `--network` | Override the environment to connect to. By default, the local development environment is used. A valid URL (starting with `http:` or `https:`) can be specified here, e.g. "http://localhost:12345/" is a valid network name. |

### Arguments

You can specify the following arguments for the `dfx wallet add-controller` command.


|Argument |Description
----------|-------------
|`controller` |Specifies the principal of the controller to add to the wallet.
| Argument | Description |
|----------|-------------|
| `controller` | Specifies the principal of the controller to add to the wallet. |

### Examples

Expand Down Expand Up @@ -156,9 +156,9 @@ dfx wallet authorize <custodian> [flag]

Use the following necessary argument with the `dfx wallet authorize` command.

|Argument |Description
----------|--------
|`<custodian>` | Specify the principal of the identity you would like to add as a custodian to the selected identity's cycles wallet.
| Argument | Description |
|----------|-------------|
| `<custodian>` | Specify the principal of the identity you would like to add as a custodian to the selected identity's cycles wallet. |

### Example

Expand Down Expand Up @@ -188,9 +188,9 @@ dfx wallet balance

You can use the following optional flags with the `dfx wallet balance` command.

|Flag |Description
-------|---------
|`--precise` |Displays the exact balance, without scaling to trillions of cycles.
| Flag | Description |
|------|-------------|
| `--precise` | Displays the exact balance, without scaling to trillions of cycles. |

### Examples

Expand Down Expand Up @@ -278,9 +278,9 @@ dfx wallet deauthorize <custodian> [flag]
Use the following necessary argument with the `dfx wallet deauthorize` command.


|Argument |Description
----------|--------------
|`<custodian>` | Specify the principal of the custodian you want to remove.
| Argument | Description |
|----------|-------------|
| `<custodian>` | Specify the principal of the custodian you want to remove. |

### Example

Expand Down Expand Up @@ -366,18 +366,18 @@ dfx wallet [network] send [flag] <destination> <amount>

You can use the following option with the `dfx wallet send` command.

|Option |Description
-----------|----------
|`--network` |Override the environment to connect to. By default, the local development environment is used. A valid URL (starting with `http:` or `https:`) can be specified here, e.g. "http://localhost:12345/" is a valid network name.
| Option | Description |
|--------|-------------|
| `--network` | Override the environment to connect to. By default, the local development environment is used. A valid URL (starting with `http:` or `https:`) can be specified here, e.g. "http://localhost:12345/" is a valid network name. |

### Arguments

You must specify the following arguments for the `dfx wallet send` command.

|Argument |Description
-----------|----------
|`<destination>` |Specify the destination canister using its canister ID.
|`<amount>` |Specify the number of cycles to send.
| Argument | Description |
|----------|-------------|
| `<destination>` | Specify the destination canister using its canister ID. |
| `<amount>` | Specify the number of cycles to send. |

### Examples

Expand Down Expand Up @@ -406,9 +406,9 @@ dfx wallet set-name [flag] <name>

You must specify the following arguments for the `dfx wallet set-name` command.

|Argument |Description
--------|------------
|`<name>` |Specify a name for the cycles wallet.
| Argument | Description |
|----------|-------------|
| `<name>` | Specify a name for the cycles wallet. |


### Example
Expand Down
Loading