From 7fb51fb5e826e0e954154d5e701152c760ce569d Mon Sep 17 00:00:00 2001 From: Martin Raszyk Date: Thu, 19 Dec 2024 08:05:07 +0100 Subject: [PATCH] docs --- docs/cli-reference/dfx-canister.mdx | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/cli-reference/dfx-canister.mdx b/docs/cli-reference/dfx-canister.mdx index 5b6f7d3b8d..7fbde18146 100644 --- a/docs/cli-reference/dfx-canister.mdx +++ b/docs/cli-reference/dfx-canister.mdx @@ -145,6 +145,7 @@ You can use the following options with the `dfx canister call` command. | `--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 replica. Instead return a response ID. | | `--candid ` | Provide the .did file with which to decode the response. Overrides value from dfx.json for project canisters. | +| `--impersonate ` | Specifies a principal on behalf of which requests to a local PocketIC instance are sent. | | `--output ` | Specifies the output format to use when displaying a method’s return result. The valid values are `idl`, 'json', `pp` and `raw`. The `pp` option is equivalent to `idl`, but is pretty-printed. | | `--query` | Sends a query request instead of an update request. For information about the difference between query and update calls, see [Canisters include both program and state](/docs/current/concepts/canisters-code#canister-state). | | `--random ` | Specifies the config for generating random arguments. | @@ -1004,10 +1005,11 @@ dfx canister status [--all | canister_name] You can use the following arguments with the `dfx canister status` command. -| Argument | Description | -|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| -| `--all` | Returns status information for all of the canisters configured in the `dfx.json` file. Note that you must specify `--all` or an individual canister name. | -| `canister_name` | Specifies the name of the canister you want to return information for. Note that you must specify either a canister name or the `--all` option. | +| Argument | Description | +|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| `--all` | Returns status information for all of the canisters configured in the `dfx.json` file. Note that you must specify `--all` or an individual canister name. | +| `--impersonate ` | Specifies a principal on behalf of which requests to a local PocketIC instance are sent. | +| `canister_name` | Specifies the name of the canister you want to return information for. Note that you must specify either a canister name or the `--all` option. | ### Examples @@ -1141,6 +1143,7 @@ You can specify the following options for the `dfx canister update-settings` com | `--add-log-viewer ` | Add a principal to the list of log viewers of the canister. Can be specified more than once to add multiple log viewers. If current log visibility is `public` or `controllers`, it will be changed to the custom allowed viewer list. | | `-c`, `--compute-allocation ` | Specifies the canister's compute allocation. This should be a percent in the range [0..100]. | | `--confirm-very-long-freezing-threshold` | Freezing thresholds above ~1.5 years require this option as confirmation. | +| `--impersonate ` | Specifies a principal on behalf of which requests to a local PocketIC instance are sent. | | `--set-controller ` | Specifies the identity name or the principal of the new controller. Can be specified more than once, indicating the canister will have multiple controllers. If any controllers are set with this parameter, any other controllers will be removed. | | `--set-log-viewer ` | Specifies the the principal of the log viewer of the canister. Can be specified more than once, indicating the canister will have multiple log viewers. If any log viewers are set with this parameter, any other log viewers will be removed. If current log visibility is `public` or `controllers`, it will be changed to the custom allowed viewer list. | | `--memory-allocation ` | Specifies how much memory the canister is allowed to use in total. This should be a value in the range [0..12 GiB]. A setting of 0 means the canister will have access to memory on a “best-effort” basis: It will only be charged for the memory it uses, but at any point in time may stop running if it tries to allocate more memory when there isn’t space available on the subnet. |