Skip to main content

Minimalist autonomous agent runner

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

Zen Mode 🧘

A minimalist, file-based autonomous agent runner. Orchestrates claude to scout, plan, code, and verify tasks using the file system as memory.

The Philosophy:

  1. Files are Database: No SQL, no vector stores, no hidden state.
  2. Markdown is API: Plans, logs, and context are just markdown files you can read and edit.
  3. Aggressive Cleanup: Designed for legacy codebases. It deletes old code rather than deprecating it.
  4. Contract First: Enforces architectural rules via a "psychological linter."

Prerequisites

1. Install Claude CLI (Required): The agent uses the official Anthropic CLI to interface with the LLM.

npm install -g @anthropic-ai/claude-cli
claude login

Installation

Option A: The Package (Recommended)

Best for general use. Zero dependencies.

pip install zen-mode

Option B: The Scripts (For Hackers)

Best if you want to modify the agent's internal logic.

Download zen.py and zen_lint.py from the scripts folder to your project root.


Workflow

1. Initialize

Run this in your project root to generate the config.

zen init

Creates .zen/ directory and CLAUDE.md (The Constitution).

2. Define the Task

Create a simple text file (e.g., task.md) describing what you want:

"Refactor the auth module to use JWTs instead of sessions. Delete the old session middleware."

3. Run the Agent

zen task.md

The agent will loop through four phases:

  1. Scout: Maps relevant code (writes to .zen/scout.md).
  2. Plan: Drafts a step-by-step plan (writes to .zen/plan.md).
  3. Implement: Executes steps one by one.
  4. Verify: Runs tests to confirm.

4. Intervention (The "Human in the Loop")

Since state is just files, you are in control:

  • Don't like the plan? Open .zen/plan.md, edit the text, and run zen task.md again. It resumes automatically.
  • Stuck on a step? Run zen task.md --retry to clear the step completion marker.
  • Total restart? Run zen task.md --reset to nuke the .zen folder.

Advanced

The Eject Button

Started with the package but want to hack the source code?

zen eject

This copies the internal logic (zen.py and zen_lint.py) into your local directory. The zen command will now use your local versions.

Configuration

Env vars (optional):

export ZEN_MODEL_BRAIN=opus       # For planning
export ZEN_MODEL_HANDS=sonnet     # For coding
export ZEN_MODEL_EYES=haiku       # For summaries
export ZEN_TIMEOUT=600            # Max seconds per step
export ZEN_LINTER_TIMEOUT=120     # Max seconds for linter
export ZEN_RETRIES=2              # Max retries per step

Upgrade After Eject

After ejecting, you're on your own for updates. Compare your local files against the scripts folder to see what changed.

Project details


Download files

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

Source Distribution

zen_mode-0.1.0.tar.gz (36.8 kB view details)

Uploaded Source

Built Distribution

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

zen_mode-0.1.0-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file zen_mode-0.1.0.tar.gz.

File metadata

  • Download URL: zen_mode-0.1.0.tar.gz
  • Upload date:
  • Size: 36.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for zen_mode-0.1.0.tar.gz
Algorithm Hash digest
SHA256 41af9a4505f772430168d83f5849ad00c9d573da8c3f9f5edf4795b39c40a289
MD5 7fc9befcecd8a3923e8fe368af753c4d
BLAKE2b-256 b57871cf3d7ec6bcc863b20fd7f8dc7a3322253d8a1b0a94db4f38d6b4378678

See more details on using hashes here.

File details

Details for the file zen_mode-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: zen_mode-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.1

File hashes

Hashes for zen_mode-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6d675a6b985fc457d4c207788677e8814300885067f6042248c7df1229bdcd96
MD5 b14e2cef2a197fb1243b7e64b6657a96
BLAKE2b-256 7d7fb751ed6a0fac7e6f7497c4eae2992b5707616b670e43961e470a75208995

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