Skip to content

Commit

Permalink
docs: add cli examples, including for --force usage
Browse files Browse the repository at this point in the history
  • Loading branch information
ekristen committed Jan 31, 2024
1 parent 7ccb153 commit 5568839
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
28 changes: 28 additions & 0 deletions docs/cli-examples.md
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
```
4 changes: 3 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ nav:
- Usage: cli-usage.md
- Options: cli-options.md
- Experimental: cli-experimental.md
- Feature Flags: cli-feature-flags.md
- Examples: cli-examples.md
- Config:
- Overview: config.md
- Filtering: config-filtering.md
Expand All @@ -84,7 +86,7 @@ nav:
- Migration Guide: config-migration.md
- Development:
- Overview: development.md
- Stanards: standards.md
- Standards: standards.md
- Resources: resources.md
- Releases: releases.md
- Testing: testing.md
Expand Down

0 comments on commit 5568839

Please sign in to comment.