Skip to content

Commit 0646089

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 0646089

File tree

2 files changed

+39
-7
lines changed

2 files changed

+39
-7
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: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,14 @@ Download the latest release from the [releases page](https://github.com/orien/st
6464

6565
```bash
6666
# Download and install (replace VERSION and ARCH as needed)
67-
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
67+
VERSION=1.0.0
68+
ARCH=linux-x86_64
69+
URL="https://github.com/orien/stackaroo/releases/download/v1.0.0/stackaroo-${VERSION}-${ARCH}.tar.gz"
70+
DIR="stackaroo-${VERSION}-${ARCH}"
71+
72+
curl -sL "$URL" | tar -xz
73+
sudo mv "${DIR}/stackaroo" /usr/local/bin/
74+
rm -rf "${DIR}"
7175

7276
# Verify installation
7377
stackaroo --version
@@ -131,5 +135,34 @@ stackaroo diff development app
131135

132136
### Key Commands
133137

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

0 commit comments

Comments
 (0)