Skip to content

Commit 4d406ad

Browse files
authored
chore: update npx ampx sandbox cli command (#8296)
* chore: update npx ampx sandbox cli command * update debug flag
1 parent 1f8c286 commit 4d406ad

File tree

1 file changed

+8
-3
lines changed
  • src/pages/[platform]/reference/cli-commands

1 file changed

+8
-3
lines changed

src/pages/[platform]/reference/cli-commands/index.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,23 @@ All commands can be prefixed with [AWS CLI environment variables](https://docs.a
4747

4848
Sandbox enables you to develop your backend alongside your frontend's development server. Run `npx ampx sandbox` to deploy to your personal cloud sandbox, this command will automatically watch for changes in the `amplify/` folder, and redeploy each time you save a file.
4949

50+
### Logs Streaming
51+
52+
- `--stream-function-logs` (_boolean_) - Whether to stream function execution logs. (default: false)
53+
- `--logs-filter` (_array_) - Regex pattern to filter logs from only matched functions. E.g. to stream logs for a function, specify it's name, and to stream logs from all functions starting with auth specify 'auth' (default: Stream all logs)
54+
- `--logs-out-file` (_string_) - File to append the streaming logs. The file is created if it does not exist. (default: stdout)
55+
5056
### Options
5157

58+
- `--debug` (_boolean_) - Print debug logs to the console (default: false)
5259
- `--dir-to-watch` (_string_) - Directory to watch for file changes. All subdirectories and files will be included. Defaults to the amplify directory.
5360
- `--exclude` (_string[]_) - An array of paths or glob patterns to ignore. Paths can be relative or absolute and can either be files or directories.
5461
- `--identifier` (_string_) - An optional name to distinguish between different sandbox environments. Default is the name of the system user executing the process
62+
- `--once` (_boolean_) - Execute a single sandbox deployment without watching for future file changes.
5563
- `--outputs-out-dir` (_string_) - A path to a directory where the client config file is written. If not provided, defaults to the working directory of the current process.
5664
- `--outputs-format` (_string_) - Format in which the client config file is written (choices: `json`, `dart`).
5765
- `--outputs-version` (_string_) - Version of the configuration. Version 0 represents classic amplify-cli config file amplify-configuration and 1 represents newer config file amplify_outputs (choices: `0`, `1`).
5866
- `--profile` (_string_) - An AWS profile name.
59-
- `--stream-function-logs` (_boolean_) - Whether to stream function execution logs. (default: false)
60-
- `--logs-filter` (_string[]_) - Regex pattern to filter logs from only matched functions. E.g. to stream logs for a function, specify it's name, and to stream logs from all functions starting with auth specify 'auth' (default: Stream all logs)
61-
- `--logs-out-file` (_string_) - File to append the streaming logs. The file is created if it does not exist. (default: stdout)
6267

6368
### Usage
6469

0 commit comments

Comments
 (0)