|
| 1 | +# vstack |
| 2 | + |
| 3 | +[](https://pypi.org/project/vstack/) |
| 4 | +[](https://github.com/eschaar/vstack/blob/main/pyproject.toml) |
| 5 | +[](https://github.com/eschaar/vstack/actions/workflows/verify.yml) |
| 6 | +[](https://github.com/eschaar/vstack/actions/workflows/security.yml) |
| 7 | +[](https://github.com/eschaar/vstack/blob/main/pyproject.toml) |
| 8 | +[](https://github.com/eschaar/vstack/blob/main/LICENSE) |
| 9 | +[](https://github.com/eschaar/vstack/discussions) |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | +The VS Code-native AI workflow system for backend engineering. |
| 14 | + |
| 15 | +vstack installs structured agents, skills, instructions, and prompts into `.github/` so GitHub Copilot Agent Mode can run repeatable backend workflows with clear role boundaries. |
| 16 | + |
| 17 | +It provides a fixed role model for end-to-end software delivery: `product`, `architect`, `designer`, `engineer`, `tester`, and `release`. |
| 18 | + |
| 19 | +## Best for |
| 20 | + |
| 21 | +- Backend and API teams using GitHub Copilot Agent Mode in VS Code |
| 22 | +- Repositories that want consistent planning, implementation, verification, and release flow |
| 23 | +- Teams that want reusable AI workflows instead of one-off prompt crafting |
| 24 | + |
| 25 | +## What you get |
| 26 | + |
| 27 | +- Fixed role model: `product`, `architect`, `designer`, `engineer`, `tester`, `release` |
| 28 | +- Template-driven install model from `src/vstack/_templates/` |
| 29 | +- Backend-first verification, security, and release discipline |
| 30 | +- Standard-library-only runtime dependencies |
| 31 | + |
| 32 | +## Quick start |
| 33 | + |
| 34 | +Install with `pipx`, then install vstack artifacts into your repository: |
| 35 | + |
| 36 | +```bash |
| 37 | +pipx install vstack |
| 38 | +vstack install --target /path/to/your/project |
| 39 | +vstack validate |
| 40 | +``` |
| 41 | + |
| 42 | +Run a first task in Copilot Agent Mode: |
| 43 | + |
| 44 | +```text |
| 45 | +@tester /verify Check this repository and summarize findings |
| 46 | +``` |
| 47 | + |
| 48 | +Expected result: |
| 49 | + |
| 50 | +- `vstack validate` reports no unresolved template tokens |
| 51 | +- Agent command returns a concrete verification summary for your repository |
| 52 | + |
| 53 | +## Why this helps |
| 54 | + |
| 55 | +- Consistent role boundaries for planning, implementation, validation, and release |
| 56 | +- Reusable skills and instructions instead of ad hoc prompts |
| 57 | +- Better release hygiene with documented workflows and CI alignment |
| 58 | + |
| 59 | +## Core commands |
| 60 | + |
| 61 | +```bash |
| 62 | +vstack --version |
| 63 | +vstack validate |
| 64 | +vstack install --target /path/to/your/project |
| 65 | +vstack verify --target /path/to/your/project |
| 66 | +``` |
| 67 | + |
| 68 | +## Common usage patterns |
| 69 | + |
| 70 | +Repository-scoped install (recommended for teams): |
| 71 | + |
| 72 | +```bash |
| 73 | +vstack install --target /path/to/your/project |
| 74 | +``` |
| 75 | + |
| 76 | +Profile-wide install (optional defaults for all projects): |
| 77 | + |
| 78 | +```bash |
| 79 | +vstack install --global |
| 80 | +``` |
| 81 | + |
| 82 | +## Fast troubleshooting |
| 83 | + |
| 84 | +- Command not found after install: ensure your `pipx` binary path is in `PATH` |
| 85 | +- Validation error: rerun `vstack install --target ...` and then `vstack validate` |
| 86 | +- Agent results look generic: explicitly invoke a role (for example `@tester`) before a skill |
| 87 | + |
| 88 | +## Full documentation |
| 89 | + |
| 90 | +For complete documentation (including architecture details, workflow diagrams, and contributor guides), use GitHub: |
| 91 | + |
| 92 | +- [GitHub repository](https://github.com/eschaar/vstack) |
| 93 | +- [Full README](https://github.com/eschaar/vstack/blob/main/README.md) |
| 94 | +- [Documentation](https://github.com/eschaar/vstack/tree/main/docs) |
| 95 | +- [Contributing guide](https://github.com/eschaar/vstack/blob/main/CONTRIBUTING.md) |
| 96 | +- [Security policy](https://github.com/eschaar/vstack/blob/main/SECURITY.md) |
0 commit comments