A tiny CLI initializer for vibe coding projects that generates .memory and .harness scaffolding.
Project description
vibefree
vibefree is a tiny Python CLI initializer for vibe coding projects. It creates a lightweight .memory and .harness scaffold so coding agents have a consistent place to read project context, rules, workflow notes, and quality expectations.
The 0.1.0 release focuses on one reliable command: vibefree init.
Features
- Creates
.memoryfiles for durable project knowledge. - Creates
.harnessfiles for coding-agent instructions. - Supports initializing the current directory or a named project directory.
- Fills missing files without overwriting existing files.
- Keeps the generated structure small, readable, and tool-agnostic.
Installation
Install from PyPI:
pip install vibefree
Usage
Initialize the current directory:
vibefree init
Initialize a named project directory:
vibefree init my-project
If my-project does not exist, it is created. If it already exists, it is reused.
Existing generated files are never overwritten. Missing files are added on later runs.
Generated Structure
.memory/
├── memory.md
├── rule.md
├── project.md
└── logs/
└── .gitkeep
.harness/
├── AGENTS.md
├── ARCHITECTURE.md
├── WORKFLOW.md
├── QUALITY.md
└── plans/
├── active/
│ └── .gitkeep
└── completed/
└── .gitkeep
Generated Files
.memory/memory.md: Long-term project memory for durable facts, decisions, and constraints..memory/rule.md: Rules for when agents should read or update memory..memory/project.md: Basic project information, including the project name..memory/logs/.gitkeep: Keeps the logs directory in version control..harness/AGENTS.md: Agent entry file with the recommended reading order..harness/ARCHITECTURE.md: Architecture notes and design decisions..harness/WORKFLOW.md: Development workflow guidance..harness/QUALITY.md: Quality, testing, and safety rules..harness/plans/active/.gitkeep: Keeps the active plans directory in version control..harness/plans/completed/.gitkeep: Keeps the completed plans directory in version control.
Development
Create a virtual environment:
python -m venv venv
Activate it on Windows PowerShell:
.\venv\Scripts\Activate.ps1
Activate it on macOS or Linux:
source venv/bin/activate
Install locally:
pip install -e .
Install development dependencies and run tests:
pip install -e ".[dev]"
pytest
Build distributions locally:
python -m build
Design Principles
- simple: keep the CLI and generated files easy to understand.
- agent-friendly: provide clear context files for coding agents and opencode-style workflows.
- no overwrite by default: preserve existing files and only create missing files.
- minimal first: start with the smallest useful structure and expand deliberately.
License
Apache License 2.0. See LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vibefree-0.1.0.tar.gz.
File metadata
- Download URL: vibefree-0.1.0.tar.gz
- Upload date:
- Size: 10.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
03c20f8f5502b259860c0d03ce745693c4a45fcc0b45cee9338e1bffacfe547e
|
|
| MD5 |
58af993877bcc99b118c9d806db90285
|
|
| BLAKE2b-256 |
eed39b9b22541dc5fe174542a31e7c15abe3cdeb681ad1934e33563ebc044062
|
File details
Details for the file vibefree-0.1.0-py3-none-any.whl.
File metadata
- Download URL: vibefree-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
511dcd7bc91c720d75a43276a1e62e67e8704e447485a3081833d50053ce1050
|
|
| MD5 |
a62a5102477831d0e44be368b8fab71a
|
|
| BLAKE2b-256 |
b4c16be9b877e6a4b016226660c4cbd6fc79c141dda4a6a75b34c0ecfdcc0e27
|