Skip to main content

goodvibes-cli

Guard rails for coding with AI. One command, no setup.

PyPI npm License

AI coding assistants write code fast, but left alone they over-build, read whole files until the context runs out, call things done without running the tests, forget earlier decisions, and run commands you would rather approve. goodvibes gives your AI tool clear working rules, adds checks that stop the most common mistakes, and sets up GitHub so every change is tested. Free, open source, no account or key.

Quick start

pip install goodvibes-cli
goodvibes init

Or with uv: uv tool install goodvibes-cli, then goodvibes init. With Node.js instead: npx goodvibes-cli init.

Then open the folder in your AI coding tool and ask for what you want to build. Run goodvibes doctor to check the setup. Getting started walks you through your first change.

What you get

  • Rules for 14 AI 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. Plan first, smallest change that works, tests before "done", decisions recorded in JOURNAL.md, ask before risky steps.
  • Journal check in every tool: a git hook blocks any commit that leaves out JOURNAL.md, from any AI tool or from you.
  • Claude Code guard rails: whole-file reads of big files and reads of .env, SSH keys and credential files are blocked; it asks before pushing, publishing, deploying or editing its own settings, and refuses force-push and git reset --hard.
  • Checks in more AI tools: the journal check and the read guard also run as hooks in Codex CLI, Gemini CLI, GitHub Copilot, Cursor, Devin CLI, Windsurf and Kiro. Not tested by running those tools; see Guard rails in other AI tools.
  • Fewer tokens: the read guard, caveman (short replies from the first message; /caveman full or stop caveman if too terse), headroom (compresses what Claude reads) and goodvibes usage (where your tokens went).
  • context7: current library docs for Claude Code, Cursor and VS Code (GitHub Copilot). Free, no key.
  • GitHub checks: tests, CodeQL and gitleaks scans, dependency review, a file size check, and Dependabot.

By default the Claude Code parts are set up for every project on your computer (in ~/.claude) and the project files go in the current folder. --scope project keeps everything in the folder. Existing files and your own settings are kept. Details: What goodvibes init sets up.

Commands

Command What it does
goodvibes init Set goodvibes up. --scope project, --minimal (skips headroom, docs/ and the CI files in .github/; Copilot's rules and hooks are still added), --dry-run
goodvibes doctor Check the setup and your MCP servers: ✓ fine, ! warning, ✗ problem
goodvibes update Bring goodvibes files up to date, keeping your edits. Shows the plan and asks once; --dry-run only shows it
goodvibes upgrade Install the newest goodvibes, then run update. In a folder with no goodvibes setup (and none in ~/.claude), it only installs and says how to update a project
goodvibes usage Tokens used by recent Claude Code sessions in this project. --all, --days N, --json. Offline

Requirements

  • Python 3.10 or later, and git
  • Optional: a GitHub account for the CI checks

Linux, macOS and Windows through WSL2 are supported; native Windows is best effort.

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). It is skipped in CI (when CI is set to anything other than 0 or false). Set DO_NOT_TRACK=1 (or true, yes) or GOODVIBES_NO_TELEMETRY=1 to turn it off. doctor and usage never send anything.

License

Apache 2.0

Release files for goodvibes-cli 1.11.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.11.1
File Size Uploaded
goodvibes_cli-1.11.1.tar.gz 170.2 kB Details

Built distribution (wheel)

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

Total release size: 361.6 kB

Release files / goodvibes_cli-1.11.1.tar.gz

Download URL goodvibes_cli-1.11.1.tar.gz
Size 170.2 kB
Tags Source
SHA-256 checksum
How to use checksums
f56d858376020dd266a0fc79e91e5af18e843bbae8065c3582336d2624cdb64b
BLAKE2b-256 checksum
How to use checksums
d60eab6b88aa0e09eccabb74ab5d86bab3ce2f311030eee39340c2ac6173b310
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

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

Download URL goodvibes_cli-1.11.1-py3-none-any.whl
Size 191.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b9c8f109501444e7f7873012c64b199eaf5bb3e868177e4e0841006900169b3e
BLAKE2b-256 checksum
How to use checksums
2d2bdb3c3fdbdee51a8d5a0a1b074d8b84b5c03814d680985c118c9cba4bbd2d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.11.1 This release

2 release files

1.11.0

2 release files

1.10.0

2 release files

1.9.1

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