Skip to content

chore: improve helptext for --always-assist #4255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

chore: improve helptext for --always-assist #4255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
78a8ae9
chore: improve helptext for --always-assist
sesi200 May 21, 2025
921d86a
documentation
sesi200 May 21, 2025
ad8df4e
Merge branch 'master' into severin/reword-candid-assist
sesi200 May 22, 2025
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
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ fees = record {

You can get the fees by `get_config` API on the [BTC Mainnet Canister](https://dashboard.internetcomputer.org/canister/ghsi2-tqaaa-aaaan-aaaca-cai).

### chore: Clarify help text for `--always-assist`

# 0.27.0

### feat!: remove the 'native' replica
Expand Down
3 changes: 3 additions & 0 deletions docs/cli-reference/dfx-canister.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ You can use the following options with the `dfx canister call` command.

| Option | Description |
|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--always-assist` | Use Candid assist when the arguments are not provided through the command line. |
| `--argument-file <argument-file>` | Specifies the file from which to read the argument to pass to the method. Stdin may be referred to as `-`. |
| `--async` | Specifies not to wait for the result of the call to be returned by polling the local development environment. Instead return a response ID. |
| `--candid <file.did>` | Provide the .did file with which to decode the response. Overrides value from `dfx.json` for project canisters. |
Expand Down Expand Up @@ -517,6 +518,7 @@ You can use the following options with the `dfx canister install` command.

| Option | Description |
|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--always-assist` | Use Candid assist when the arguments are not provided through the command line or dfx.json. |
| `--argument <argument>` | Specifies an argument to pass to the canister during installation. |
| `--argument-type <argument-type>` | Specifies the data type for the argument when making the call using an argument [possible values: idl, raw] |
| `--argument-file <argument-file>` | Specifies the file from which to read the argument to pass to the init method. Stdin may be referred to as `-`. |
Expand Down Expand Up @@ -848,6 +850,7 @@ You can specify the following options for the `dfx canister sign` command.

| Option | Description |
|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| `--always-assist` | Use Candid assist when the arguments are not provided through the command line. |
| `--argument-file <file>` | Specifies the file from which to read the argument to pass to the method. Stdin may be referred to as `-`. |
| `--expire-after <seconds>` | Specifies how long the message will be valid before it expires and cannot be sent. Specify in seconds. If not defined, the default is 300s (5m). |
| `--file <output>` | Specifies the output file name. The default is `message.json`. |
Expand Down
1 change: 1 addition & 0 deletions docs/cli-reference/dfx-deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ You can use the following options with the `dfx deploy` command.
| `--network <network>` | Overrides the environment to connect to. By default, the local development environment is used. |
| `--playground ` | Alias for `--network playground`. |
| `--ic ` | Alias for `--network ic`. |
| `--always-assist` | Use Candid assist when the arguments are not provided through the command line or dfx.json. |
| `--argument <argument>` | Specifies an argument to pass to the canister during installation. |
| `--argument-type <argument-type>` | Specifies the data type for the argument when making the call using an argument [possible values: idl, raw] |
| `--argument-file <argument-file>` | Specifies the file from which to read the argument to pass to the init method. Stdin may be referred to as `-`. |
Expand Down
2 changes: 1 addition & 1 deletion src/dfx/src/commands/canister/call.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ pub struct CanisterCallOpts {
#[arg(long)]
candid: Option<PathBuf>,

/// Always use Candid assist when the argument types are all optional.
/// Use Candid assist when the arguments are not provided through the command line.
#[arg(
long,
conflicts_with("argument"),
Expand Down
2 changes: 1 addition & 1 deletion src/dfx/src/commands/canister/install.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ pub struct CanisterInstallOpts {
#[arg(long)]
no_asset_upgrade: bool,

/// Always use Candid assist when the argument types are all optional.
/// Use Candid assist when the arguments are not provided through the command line or dfx.json.
#[arg(
long,
conflicts_with("argument"),
Expand Down
2 changes: 1 addition & 1 deletion src/dfx/src/commands/canister/sign.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ pub struct CanisterSignOpts {
#[arg(long, default_value = "message.json")]
file: PathBuf,

/// Always use Candid assist when the argument types are all optional.
/// Use Candid assist when the arguments are not provided through the command line.
#[arg(
long,
conflicts_with("argument"),
Expand Down
2 changes: 1 addition & 1 deletion src/dfx/src/commands/deploy.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ pub struct DeployOpts {
#[command(flatten)]
subnet_selection: SubnetSelectionOpt,

/// Always use Candid assist when the argument types are all optional.
/// Use Candid assist when the arguments are not provided through the command line or dfx.json.
#[arg(
long,
conflicts_with("argument"),
Expand Down
Loading