-
-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #63 from ekristen/docs-examples
docs: add cli examples, including for --force usage
- Loading branch information
Showing
2 changed files
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Examples | ||
|
||
## Basic usage | ||
|
||
```bash | ||
aws-nuke --config config.yml | ||
``` | ||
|
||
## Using a profile | ||
|
||
!!! note | ||
This assumes you have configured your AWS credentials file with a profile named `my-profile`. | ||
|
||
```bash | ||
aws-nuke --config config.yml --profile my-profile | ||
``` | ||
|
||
## Using the force flags | ||
|
||
!!! danger | ||
Running without prompts can be dangerous. Make sure you understand what you are doing before using these flags. | ||
|
||
The following is an example of how you automate the command to run without any prompts of the user. This is useful | ||
for running in a CI/CD pipeline. | ||
|
||
```bash | ||
aws-nuke --config config.yml --force --force-delay 5 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters