Skip to content

ruifrvaz/smaqit

Repository files navigation

smaqit banner

Welcome to smaQit, an agent orchestration toolkit for developers building software using Spec Driven Development. You describe requirements, specification agents generate stateful specs, then implementation agents turn those specs into working, tested and deployed applications. Built for teams that value auditability, clear boundaries, and reproducible workflows.

Features

  • Lightweight — Single binary, no dependencies. smaqit init scaffolds everything.
  • Auditable prompts — Requirements captured in versioned prompt files with full traceability.
  • Stateful specs — Specifications track lifecycle: draft → implemented → deployed → validated.
  • Bounded agents — Each agent owns one layer or phase. No scope creep.
  • Self-validating — Agents verify their own output before completion.
  • Spec-first — Code follows specs, not the other way around.

Compatibility

Currently supported:

Platform Status
GitHub Copilot (VS Code) ✅ Supported
Other AI assistants Planned

Getting Started

Install:

curl -fsSL https://raw.githubusercontent.com/ruifrvaz/smaqit/main/install.sh | bash

Initialize:

smaqit init

Build something:

  1. Fill .github/prompts/smaqit.business.prompt.md with your requirements
  2. Open GitHub Copilot chat and run /smaqit.development
  3. Watch specs generate, then code build

See the full Mario Hello quickstart for a complete walkthrough.

Copilot Automation

smaqit includes a GitHub Action workflow that automatically installs smaqit before Copilot coding agent sessions. Add to .github/copilot-instructions.md:

## Environment Setup
Setup steps: `.github/workflows/copilot-setup-steps.yml`

Commands

CLI:

Command Description
smaqit init Scaffold .smaqit/ and .github/ directories
smaqit status Show project state and spec coverage
smaqit plan Show specs to process (for agents)
smaqit validate Verify project structure integrity
smaqit help Show detailed command help
smaqit uninstall Remove smaqit from project
smaqit version Show smaqit version

Agents (invoke in GitHub Copilot chat with /):

Agent Purpose
/smaqit.development Build working app from specs
/smaqit.deployment Deploy to target environment
/smaqit.validation Run tests against deployed system

Run smaqit help for all specification agents (/smaqit.business, /smaqit.functional, etc.).

Documentation

  • Quickstart — Build "Hello, Mario!" from scratch
  • Team Alignment — How layers map to Agile roles
  • Wiki — Concepts, designs, patterns, workflows

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •