@spreadworks/senti
v0.1.0-alpha.1383
Published
Spec-Driven Development tooling for automated documentation generation
Maintainers
Readme
senti
日本語 | English
Alpha: APIs, command structure, and configuration formats may change without notice.
Spec-Driven Development — Design, implement, and document in a single flow
A spec-first development flow manager designed to work with AI coding agents.
The Spec-Driven Development Flow
Every feature goes through three phases, from spec to merge.
plan ──────── Specification
│ ├─ draft Refine requirements through dialogue
│ ├─ spec Create spec (feature branch + spec.md)
│ ├─ gate Spec validation + guardrail check
│ └─ test Write test code
│
implement ─── Coding
│ ├─ implement Write code after gate PASS
│ └─ review AI code review
│
finalize ──── Wrap-up
│ ├─ commit Commit + retro + report
│ ├─ merge Squash merge or PR
│ ├─ sync Auto-update documentation
│ └─ cleanup Remove branch / worktreeAI stays in its lane
Source code analysis, spec gate checks, and flow orchestration are all handled by deterministic commands. AI is not in charge of the flow — it assists with spec drafting, code review, and prose generation within well-defined boundaries.
- Spec gate — Programmatic validation of unresolved items and missing approvals. No PASS, no implementation
- Guardrails — Project-specific design principles checked against each spec
- Compaction resilience — Flow state and requirements are persisted, so you can resume after context compression
Automatic Doc Sync
Source code is statically analyzed to extract file structure, classes, methods, configuration, and dependencies. The extracted data is injected into templates to produce structured documentation (docs/) and README.md.
Documentation is automatically refreshed during the merge phase, so docs and code never drift apart. With always-current docs, both humans and AI agents can understand the system without reading every source file.
Quick Start
Install
Setup
An interactive wizard configures your project type (preset) and AI agent.
Generate docs for an existing project
If you already have source code, generate documentation to get a complete picture of the system. Especially useful for onboarding onto legacy codebases.
Develop with the Spec-Driven Development flow
Claude Code — run each phase via skills:
| Skill | Phase |
|---|---|
| /senti.flow | full Spec-Driven Development flow (plan, implement, finalize) |
Codex CLI — invoke via $ prefix:
| Command | Phase |
|---|---|
| $senti.flow | full Spec-Driven Development flow (plan, implement, finalize) |
Commands
| Command | Description |
|---|---|
| setup | Register project and generate config |
| docs build | Run the full documentation pipeline |
See senti help or the command reference for the full list.
Configuration
setup generates .senti/config.json:
{
"type": "node-cli", // project type (preset name)
"lang": "en", // operating language
"agent": {
"default": "claude", // AI agent
"providers": { ... } // agent settings
}
}See the configuration reference for details.
Documentation
| Chapter | Summary | | --- | --- | | Tool Overview and Architecture | This chapter introduces senti, a CLI tool that automates documentation generation from source code analysis and e… | | Technology Stack and Operations | This chapter covers the technology stack, dependency management, deployment, and operations procedures for senti,… | | Project Structure | This chapter describes the overall directory organization of the senti project, which is structured around seven … | | CLI Command Reference | The CLI is organized as command groups that dispatch subcommands from registries, with docs, flow, metrics, spec, and… | | Configuration and Customization | senti is configured through a single project-level JSON file (.senti/config.json) and optionally extended by … | | Internal Design | This project is organized around three main areas: src/docs for documentation analysis and generation, src/flow for S… | | Preset Creation Guide | |
License
MIT
