Skip to main content

Civyk Hatch Advanced - Zero-Prompt Architecture CLI for AI-powered development

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

civyk_hatch-5.0.0-cp313-cp313-win_amd64.whl (7.4 MB view details)

Uploaded CPython 3.13Windows x86-64

civyk_hatch-5.0.0-cp312-cp312-win_amd64.whl (7.5 MB view details)

Uploaded CPython 3.12Windows x86-64

civyk_hatch-5.0.0-cp311-cp311-win_amd64.whl (7.5 MB view details)

Uploaded CPython 3.11Windows x86-64

civyk_hatch-5.0.0-cp310-cp310-win_amd64.whl (7.2 MB view details)

Uploaded CPython 3.10Windows x86-64

File details

Details for the file civyk_hatch-5.0.0-cp313-cp313-win_amd64.whl.

File metadata

File hashes

Hashes for civyk_hatch-5.0.0-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 3dbfb395e4933162fb29b5f4da09ac0e280d8bcd6750912b865d29fbf26275dc
MD5 a6d871beebcee3cd030c425d7925021f
BLAKE2b-256 09411aef6c26bbf13441f0dbe4d917d5b59a902a7d124c5761e625a43226ff85

See more details on using hashes here.

File details

Details for the file civyk_hatch-5.0.0-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for civyk_hatch-5.0.0-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 1ef93933d752ab39356058beb2a4c5ca8045d1845beef290982ff09b7dee5ac1
MD5 5417c4b3795ff00bbcc6a714413559b4
BLAKE2b-256 275de8b85739e897281daaf28c594049fb82b59e73f60f1c1e1af6a0f7b561b4

See more details on using hashes here.

File details

Details for the file civyk_hatch-5.0.0-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for civyk_hatch-5.0.0-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 72fdc0b62bdd53229a1e935556e644a286fe4744b54e27580f710f3de2c7ac61
MD5 9ec9828d48eff6debc696db55737ad6d
BLAKE2b-256 3dd043baf86abcbce37e876965e81d4703c891426ed6b0681c9e8fa11a1b3970

See more details on using hashes here.

File details

Details for the file civyk_hatch-5.0.0-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for civyk_hatch-5.0.0-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 35b4bb46c057a40026198ec32e596bc95b9fadc42a50669882a09209ca4fdce5
MD5 8ae62bf71366e8e1bc77cb082ce427d0
BLAKE2b-256 657a3005f895a61801c16c0c9ac7b4700720a446b4f2966e3a7e0336e189403c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page