Skip to main content

goodvibes-cli

One command. Production-grade project. No config.

PyPI npm CI License

goodvibes is a single-command bootstrap for people who want to vibe code with an LLM and not worry about the rest. Run goodvibes init, start coding, and everything else — code hygiene, token efficiency, git discipline, CI/CD — happens automatically in the background.

Quick start

pip install goodvibes-cli
goodvibes init

Or without installing (Node.js):

npx goodvibes-cli init

By default this sets goodvibes up for every project on your computer (rules, skills, hooks and context7 in ~/.claude, plus the goodvibes command installed globally) and adds the project files to the current folder. Add --scope project to keep everything inside this one project. Details: Global or one project.

What you get

  1. Engineering rules for Claude: think before coding, simplicity first, fail loud, keep a journal, update tests. In ~/.claude/rules/goodvibes.md by default, or this project's CLAUDE.md with --scope project
  2. IDE rule files: the same rules for 14 AI coding tools: Claude Code, Cursor, GitHub Copilot, Windsurf, Devin Desktop, Kiro, Antigravity, Cline, Amazon Q, Continue.dev, OpenAI Codex CLI, Lovable, Replit Agent, and Bolt.new
  3. Skills: caveman (shorter replies, so context lasts longer), model-regression (loaded only when a change touches model or metric code) and others
  4. ponytail rules: keeps code minimal; no over-engineering
  5. headroom: compresses what Claude reads, so context lasts longer (requires Python 3.10+; skipped gracefully if absent)
  6. Journal check (Claude Code only): Claude Code cannot git commit until JOURNAL.md is staged
  7. context7 (Claude Code): up-to-date library docs, free, no key
  8. Session check (Claude Code only): goodvibes doctor --quick runs when Claude Code starts and stays silent unless something needs fixing

Running it a second time is safe: existing files are not overwritten, and your own settings are kept.

Commands and flags

goodvibes init --dry-run         # Preview files without writing anything
goodvibes init --minimal         # Skip headroom install, all .github/ files, and docs/
goodvibes init --scope project   # Everything inside this project only (default: global)
goodvibes update                 # Bring goodvibes files up to date; keeps your edits (--dry-run to preview)
goodvibes upgrade                # Install the newest goodvibes, then run update
goodvibes doctor                 # Check the setup and print a fix for anything missing

Requirements

  • Python 3.10+
  • git
  • A GitHub account (for CI)

Windows users: Use WSL2 for the best experience.

Privacy: goodvibes init sends one anonymous install count: an empty request with a random ID, nothing about you or your code (the server sees your IP address, as with any request). Set GOODVIBES_NO_TELEMETRY=1 or DO_NOT_TRACK=1 to turn it off.

IDE support

goodvibes init writes a rule file for each supported AI coding tool. All rule files encode the same engineering principles and activate automatically — no user configuration needed.

IDE File written Activation
Claude Code ~/.claude/rules/goodvibes.md (default) or CLAUDE.md Automatic
Cursor .cursor/rules/goodvibes.mdc Automatic (alwaysApply: true)
GitHub Copilot .github/copilot-instructions.md Automatic
Windsurf .windsurfrules Automatic
Devin Desktop .devin/rules/goodvibes.md Automatic
Kiro .kiro/steering/goodvibes.md Automatic
Antigravity GEMINI.md Automatic
Cline .clinerules/goodvibes.md Automatic
Amazon Q .amazonq/rules/goodvibes.md Automatic
Continue.dev .continue/rules/goodvibes.md Automatic
OpenAI Codex CLI AGENTS.md Automatic
Lovable AGENTS.md + CLAUDE.md Automatic
Replit Agent replit.md Automatic
Bolt.new .bolt/prompt Automatic

License

Apache 2.0

Release files for goodvibes-cli 1.9.1

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

Source distribution (sdist)

Source distribution for goodvibes-cli 1.9.1
File Size Uploaded
goodvibes_cli-1.9.1.tar.gz 106.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for goodvibes-cli 1.9.1
File Interpreter ABI Platform
goodvibes_cli-1.9.1-py3-none-any.whl Python 3 none any Details

Total release size: 204.1 kB

Release files / goodvibes_cli-1.9.1.tar.gz

Download URL goodvibes_cli-1.9.1.tar.gz
Size 106.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f7db1fa091a2085dafcbe894087f80b5b77d32fd7f70503b47a220f5c8a9266a
BLAKE2b-256 checksum
How to use checksums
d16bec5c3233d8649a9aab39ce4d8e212e1bc5c95124e8320022f6c8ff5bdc25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.18 {"installer":{"name":"uv","version":"0.12.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / goodvibes_cli-1.9.1-py3-none-any.whl

Download URL goodvibes_cli-1.9.1-py3-none-any.whl
Size 97.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
314a7a829c1a65ee69cacab89faa335860b55f1f4205affbb8b3bc61efce3156
BLAKE2b-256 checksum
How to use checksums
e8cfae2b7b078c793ac4e296133743f6db8cd477946e28efc5df8933bc263f25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.18 {"installer":{"name":"uv","version":"0.12.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

1.9.1 This release

2 release files

1.9.0

2 release files

1.8.0

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.2

2 release files

1.6.1

2 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