Skip to content

Docs: update CLI usage examples for v3 run subcommand + alias check/bypass + blocklist key #882

@ipkstef

Description

@ipkstef

Running v3.63.4 using the root command with -c fails because -c/--config is only on the run subcommand.
The docs don’t make this obvious, and they also don’t mention the required account alias check (or how to
bypass it safely). The config key account-blocklist is also deprecated in v3 in favor of blocklist, but
that’s easy to miss.

Steps to Reproduce

  1. aws-nuke -c aws-nuke.yml --profile $profile
  2. aws-nuke run --config aws-nuke.yml --profile $profile

Actual

  • Step 1: flag provided but not defined: -c
  • Step 2 (if account has no alias): specified account doesn't have an alias... For safety reasons you need
    to specify an account alias...

Expected

  • Docs clearly show v3 usage: aws-nuke run --config ...
  • Docs explain account alias requirement + how to bypass with --no-alias-check and bypass-alias-check-
    accounts
  • Docs mention blocklist instead of deprecated account-blocklist

Environment

  • aws-nuke v3.63.4 (Homebrew)
  • macOS (Apple Silicon)
  • Config uses shared profile

Suggested Doc Updates

  • Update README/usage examples to include aws-nuke run --config ...
  • Add a short “Account alias check” note with --no-alias-check + bypass-alias-check-accounts
  • Replace account-blocklist with blocklist in examples

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions