Skip to content

Commit 52e7b95

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 52e7b95

File tree

2 files changed

+33
-6
lines changed

2 files changed

+33
-6
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: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,8 @@ Download the latest release from the [releases page](https://github.com/orien/st
6565
```bash
6666
# Download and install (replace VERSION and ARCH as needed)
6767
curl -sL https://github.com/orien/stackaroo/releases/download/v1.0.0/stackaroo-1.0.0-linux-x86_64.tar.gz | tar -xz
68-
cd stackaroo-1.0.0-linux-x86_64
69-
sudo mv stackaroo /usr/local/bin/
70-
cd .. && rm -rf stackaroo-1.0.0-linux-x86_64
68+
sudo mv stackaroo-1.0.0-linux-x86_64/stackaroo /usr/local/bin/
69+
rm -rf stackaroo-1.0.0-linux-x86_64
7170

7271
# Verify installation
7372
stackaroo --version
@@ -131,5 +130,34 @@ stackaroo diff development app
131130

132131
### Key Commands
133132

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

0 commit comments

Comments
 (0)