Skip to content

Commit 4a30399

Browse files
committed
docs: expand Key Commands section with comprehensive command reference
- Add missing delete command to documentation - Include all global flags (--config, --verbose, --version, --help) - Add practical usage examples for all commands - Emphasise dependency-aware ordering for both deploy and delete commands - Provide complete quick reference for users
1 parent 8db610f commit 4a30399

File tree

2 files changed

+31
-3
lines changed

2 files changed

+31
-3
lines changed

AGENTS.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,6 @@ Must be presented to and approved by the human before committing.
413413
### Debug Flags
414414
- Use `--verbose` flag for detailed output
415415
- Enable AWS SDK logging with environment variables
416-
- Use `--dry-run` for safe testing
417416

418417
### Logging
419418
- Use structured logging for AWS operations

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,5 +131,34 @@ stackaroo diff development app
131131

132132
### Key Commands
133133

134-
- `deploy <context> [stack]` - Deploy all stacks or a specific stack
135-
- `diff <context> <stack>` - Preview changes before deployment
134+
#### Core Commands
135+
- `deploy <context> [stack-name]` - Deploy all stacks or a specific stack with dependency-aware ordering and integrated change preview
136+
- `diff <context> <stack-name>` - Preview changes between deployed stack and local configuration
137+
- `delete <context> [stack-name]` - Delete stacks with dependency-aware ordering and confirmation prompts
138+
139+
#### Global Flags
140+
- `--config, -c` - Specify config file (default: stackaroo.yaml)
141+
- `--verbose, -v` - Enable verbose output for detailed logging
142+
- `--version` - Show version information
143+
- `--help` - Show help for any command
144+
145+
#### Usage Examples
146+
```bash
147+
# Deploy all stacks in development context
148+
stackaroo deploy development
149+
150+
# Deploy specific stack with verbose output
151+
stackaroo deploy production app --verbose
152+
153+
# Preview changes before deployment
154+
stackaroo diff staging vpc
155+
156+
# Delete specific stack with confirmation
157+
stackaroo delete development app
158+
159+
# Delete all stacks in context (reverse dependency order)
160+
stackaroo delete development
161+
162+
# Use custom config file
163+
stackaroo deploy prod --config custom-config.yaml
164+
```

0 commit comments

Comments
 (0)