Skip to main content

Civyk Hatch

"Build fair. Build clean. Build for people."

Python 3.10+ License: Proprietary PyPI

Zero-prompt architecture CLI for AI-powered development workflows — Progressive prompt injection that guides AI agents through structured development stages.

Problem: AI coding assistants are powerful but unpredictable. Without structure, they produce inconsistent results, skip edge cases, and lack traceability from requirements to code.

Solution: Civyk Hatch provides structured, stage-based workflows that guide AI agents through specification, planning, implementation, and review — with full state persistence and auto-resume.


Core Features

  • Progressive Prompt Injection — Small, focused prompts (50-80 lines) at each stage
  • Folder-Based State Management — Simple state persistence using feature folders
  • Template System — Reusable templates with variable substitution
  • Multi-Workflow Support — Specification, planning, implementation, review, and more
  • Cross-Platform — Works on Linux, macOS, and Windows
  • Free binaries — Compiled binaries available via PyPI at no cost

Quick Start

Installation

pip install civyk-hatch

Setup for Your AI Agent (Optional)

Slash commands are optional. You can use direct prompting without any setup (see Usage).

To install for your AI agent:

cd /path/to/your/project

# Fully interactive setup (recommended)
civyk-hatch init

# CLI mode: slash commands
civyk-hatch init . --ai claude --mode cli

# MCP mode: JSON-RPC server
civyk-hatch init . --ai claude --mode mcp

# Configure all supported agents at once
civyk-hatch init . --all

The interactive mode prompts for project location, AI assistant, and integration mode.

Supported agents: claude, cursor-agent, windsurf, copilot, opencode, kilocode, antigravity, gemini, qwen, codex, roo, amp, q

Verify Installation

civyk-hatch --version

Available Workflows

Command Description Stages
constitution Create project constitution 3
specify Create baseline specification 6
clarify Ask structured questions 3
plan Create implementation plan 4
tasks Generate actionable tasks 4
analyze Cross-artifact consistency analysis 3
implement Execute implementation 5
tests Iterative test implementation 2
review Deep code review and remediation 2
checklist Generate quality checklist 3
analyze-project Analyze existing project 16
deepwiki Generate AI-powered wiki documentation 16
generate-guidelines Generate coding guidelines from documents 4
sync-docs Sync documentation with codebase 2
understand Build hierarchical codebase understanding 5
orchestrate Orchestrate complete spec-driven workflow -

Usage

List Available Commands

civyk-hatch --help

Option 1: Direct Prompting (No Setup Required)

Simply prompt your AI coding assistant directly:

Run CLI: `civyk-hatch specify`. Follow all instructions in the output.

Replace specify with any available command:

Run CLI: `civyk-hatch review`. Follow all instructions in the output.
Run CLI: `civyk-hatch tests`. Follow all instructions in the output.
Run CLI: `civyk-hatch plan`. Follow all instructions in the output.
Run CLI: `civyk-hatch analyze-project`. Follow all instructions in the output.

The AI agent will execute the CLI command and follow the emitted prompts automatically.

Option 2: Slash Commands (Requires Init)

For a more integrated experience, run civyk-hatch init to install slash commands:

/civyk-hatch.specify     # Start specification workflow
/civyk-hatch.plan        # Start planning workflow
/civyk-hatch.implement   # Start implementation workflow
/civyk-hatch.review      # Start code review workflow
/civyk-hatch.tests       # Start test implementation workflow

How slash commands work:

  1. User types slash command in their AI assistant
  2. Slash command loads a prompt that instructs the AI agent
  3. AI agent executes civyk-hatch CLI commands to drive the workflow
  4. CLI emits stage prompts that guide the AI through each step

Auto-Resume

All feature-scoped commands support automatic state detection:

civyk-hatch plan --stage=1     # Early stages need explicit --stage
civyk-hatch plan --stage=2     # Still no state (created at stage 3)
civyk-hatch plan               # Stage 3+: auto-detects everything!
civyk-hatch resume             # See what's next

Integration with civyk-repoix

Civyk Hatch integrates with civyk-repoix for enhanced code intelligence:

  • MCP Mode — Direct integration when MCP is available
  • CLI Mode — Fallback for restricted environments

The review and test workflows automatically detect which mode is available and use appropriate commands.


Configuration

AGENTS.md

Place AGENTS.md in your repository root to configure AI agent behavior:

my-project/
├── AGENTS.md          # AI agent guidelines (repo root only)
├── memory/
│   └── constitution.md
└── specs/

The AI agent reads AGENTS.md at workflow start for project-specific instructions.


Principles

This project follows Civyk's core values:

  1. Users are customers, not inventory — We make money by providing value
  2. No dark patterns, ever — Honest communication, no manipulation
  3. No silent telemetry — You know exactly what we collect and why
  4. Consent is explicit & reversible — Full control over your data
  5. Long-term trust > short-term growth — Building for sustainability

Support

Help keep this project alive and growing!

If Civyk Hatch has helped your development workflow, consider supporting its continued development. Your contribution helps with:

  • Ongoing maintenance and bug fixes
  • New feature development
  • Infrastructure costs

50% of all donations go directly to children's charities helping those in need. The remaining funds support project maintenance and feature upgrades.

Buy Me a Coffee Ko-fi

Every contribution, no matter the size, makes a difference.


License

Proprietary — see LICENSE

Free to use: Compiled binaries are available via PyPI at no cost for personal and commercial use.


Built on Trust, Driven by Value

Metadata

Release files for civyk-hatch 5.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for civyk-hatch 5.3.0
File
civyk_hatch-5.3.0-cp313-cp313-win_amd64.whl CPython 3.13 CPython 3.13 Windows x86-64 Details
civyk_hatch-5.3.0-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details
civyk_hatch-5.3.0-cp311-cp311-win_amd64.whl CPython 3.11 CPython 3.11 Windows x86-64 Details
civyk_hatch-5.3.0-cp310-cp310-win_amd64.whl CPython 3.10 CPython 3.10 Windows x86-64 Details

Total release size: 30.1 MB

Release files / civyk_hatch-5.3.0-cp313-cp313-win_amd64.whl

Download URL civyk_hatch-5.3.0-cp313-cp313-win_amd64.whl
Size 7.6 MB
Tags CPython 3.13 Windows x86-64
SHA-256 checksum
How to use checksums
42556b8a4daf44c56d2aec449e7ec350f9f6ee6e00f8226686d27495469d94ab
BLAKE2b-256 checksum
How to use checksums
0a27503512ae90c6fd9506b0924329ed04e82de067846b75bd18d577d5a959c9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / civyk_hatch-5.3.0-cp312-cp312-win_amd64.whl

Download URL civyk_hatch-5.3.0-cp312-cp312-win_amd64.whl
Size 7.6 MB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
1cb993b40c2a40884298356461f155c764a6999a337c700099082ad5444dac66
BLAKE2b-256 checksum
How to use checksums
9f415790f61693cff3c7aac2b6d3218b738667b5fa37b4103b247fceb51af459
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / civyk_hatch-5.3.0-cp311-cp311-win_amd64.whl

Download URL civyk_hatch-5.3.0-cp311-cp311-win_amd64.whl
Size 7.6 MB
Tags CPython 3.11 Windows x86-64
SHA-256 checksum
How to use checksums
ec07871f1f6a416b7c337b2a75d8909d714ba159773bfc7363944bc56ad44c22
BLAKE2b-256 checksum
How to use checksums
250b88c85415eff9906ab45ca775b88806c2f6ff70c6e05b040269b82b7c7928
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / civyk_hatch-5.3.0-cp310-cp310-win_amd64.whl

Download URL civyk_hatch-5.3.0-cp310-cp310-win_amd64.whl
Size 7.3 MB
Tags CPython 3.10 Windows x86-64
SHA-256 checksum
How to use checksums
f867a1ac11ea5e572104e1cdfcd472a699dc2457b2a1649284e3c0f4dedb9a7c
BLAKE2b-256 checksum
How to use checksums
500e2248b134c2eb4628cdfc5136f543e81e198a449d3e3f315327b02ffe1392
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

5.3.0 This release

4 release files

5.0.0

4 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page