Skip to main content

AI coding safety system for vibecoders

Project description

VibeLign Banner

๐Ÿ‡ฐ๐Ÿ‡ท ํ•œ๊ตญ์–ด ย |ย  ๐Ÿ‡บ๐Ÿ‡ธ English

PyPI GitHub Release Python MIT AI Tools


๐ŸŽฎ VibeLign โ€” Safety Guard for AI Coding

VibeLign (vibelign) is an AI coding safety CLI + Desktop GUI for vibe coding workflows. It helps developers and non-developers protect project structure, save checkpoints, undo bad AI edits, manage anchors, and block secret leaks before commit.

๐Ÿ†• v2.0: Desktop app for macOS / Windows, per-document AI summarization, anchor intent regeneration. See CHANGELOG and migration notes.

Documentation: https://yesonsys03-web.github.io/VibeLign/
Repository: https://github.com/yesonsys03-web/VibeLign
Issues: https://github.com/yesonsys03-web/VibeLign/issues
Releases: https://github.com/yesonsys03-web/VibeLign/releases

Sound familiar?

  • You asked AI to add a small feature โ€” it rewrote the entire file
  • All code ended up in main.py โ€” 1000+ lines, impossible to manage
  • AI touched other files and now nothing works
  • You want to undo but don't know how

That's why we made this!

Desktop App (macOS / Windows) โ€” ๐Ÿ“ฅ Download latest release

Mac / Linux (CLI)

pip install vibelign
vib start

Windows (PowerShell, CLI)

# Step 1: install uv โ€” one-time setup, auto-configures PATH
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
# Close and reopen PowerShell, then:
uv tool install vibelign
vib start

Quick Start


๐Ÿค” What is VibeLign?

AI coding tools (Claude Code, Cursor, etc.) write code fast. But they have problems:

Problem VibeLign Fixes It
All code goes into main.py AI organizes code properly
AI does something different from what you asked Creates precise edit requests
Code breaks and you can't go back Save & Undo feature

Works with any AI tool: Claude Code ยท Cursor ยท Codex ยท OpenCode


๐Ÿ“ Just 3 Things to Remember

Before AI edits  โ†’  vib checkpoint "before work"    # save
AI broke it      โ†’  vib undo                         # undo
Looks good       โ†’  vib checkpoint "done"             # save again

No Git knowledge needed. Just type vib.


๐Ÿš€ Start in 3 Steps

Mac / Linux

# 1. Install
pip install vibelign

# 2. Go to your project folder
cd my-project

# 3. Start!
vib start

Windows (PowerShell)

# 1. Install uv โ€” one-time setup (auto-configures PATH, no warnings)
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

# Close and reopen PowerShell, then:

# 2. Install vibelign
uv tool install vibelign

# 3. Go to your project folder and start!
cd my-project
vib start

๐Ÿ“š All Commands

Basics (Must Know)

Command What It Does
vib start First time only! Set up project
vib checkpoint "message" Save current state (like game save)
vib checkpoint Will ask for a message
vib undo Go back to last save
vib history See all saves

When Asking AI to Code

Command What It Does
vib patch "add button" Tell AI exactly how to edit (Korean OK!)
vib anchor Mark safe areas for AI to edit
vib scan Clean up files + check status

VibeLign patch rules

  • Split composite requests into intent / source / destination / behavior_constraint.
  • If delete and move appear together, treat it as move + preservation unless the user clearly wants removal.
  • Resolve source and destination by role, not with the same rule.
  • If patch contract or codespeak shape changes, update tests and docs together.
  • Keep terminology aligned with the shared glossary and project docs.

Checking & Verification

Command What It Does
vib doctor Check project health
vib explain Explain changes in plain language
vib guard Check if code is broken
vib ask filename.py Ask AI to explain a file

File Protection

Command What It Does
vib protect filename.py Lock important files (AI can't touch)
vib protect --list See locked files
vib protect --remove filename.py Unlock file
vib secrets --staged Block staged API keys, tokens, and .env files before commit

Settings & Export

Command What It Does
vib config Set API keys
vib export claude Create Claude Code settings
vib export cursor Create Cursor settings
vib export opencode Create OpenCode settings

Other Useful Commands

Command What It Does
vib watch Monitor file changes in real-time
vib bench Test how effective anchors are
vib manual Show detailed user guide
vib rules Show all AI development rules
vib transfer Generate PROJECT_CONTEXT.md for switching AI tools
vib transfer --handoff Add Session Handoff block so a new AI can continue immediately
vib completion Set up tab autocomplete
vib install Show step-by-step installation guide

๐Ÿ’ก Recommended Workflow

# First time
vib start

# Before AI edits
vib checkpoint "before login feature"
vib doctor --strict
vib patch "create login button"

# After AI edits
vib explain --write-report
vib guard --strict --write-report

# If done
vib checkpoint "login feature done!"

# If something broke
vib undo

# Hitting a token limit or switching AI tools?
vib transfer --handoff    # generates a Session Handoff block
# Then tell the new AI: "Read PROJECT_CONTEXT.md first"

vib start now also enables Git secret protection automatically when your project uses Git. Before each commit, VibeLign checks staged changes for API keys, tokens, private keys, and secret-like files such as .env.

# Check manually anytime
vib secrets --staged

๐Ÿ”ง Installation

Option 1: uv (Recommended, faster)

uv tool install vibelign

If you see "is not on your PATH" warning after install:

uv tool update-shell

Then close and reopen your terminal. vib will work after that. If you use bash, run uv tool update-shell from inside bash, or:

echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc && source ~/.bashrc

Option 2: pip

pip install vibelign

After installation, both vib and vibelign commands are available.

Option 3: Desktop App (GUI)

Download the latest .dmg (macOS, Apple Silicon) or .exe / .msi (Windows) from the Releases page. The GUI bundles the vib runtime โ€” no separate CLI install required.

macOS first-launch: if you see "app is damaged", open Terminal and run xattr -rc vibelign-gui.app (ad-hoc signed, not notarized).

Windows โ€” if vib is not recognized after pip install

When you install with pip on Windows, vib.exe is placed in the Python Scripts folder which may not be in PATH. The pip warning message shows the exact path you need to add:

WARNING: The scripts vib.exe ... are installed in 'C:\Users\...\Scripts' which is not on PATH.

To fix manually:

  1. Press Win + R โ†’ type sysdm.cpl โ†’ Enter
  2. Advanced tab โ†’ Environment Variables
  3. Under System variables, find Path โ†’ click Edit
  4. Click New and paste the Scripts path shown in the pip warning
    • Example: C:\Users\YourName\AppData\Local\Programs\Python\Python312\Scripts\
  5. Click OK โ†’ fully close and reopen PowerShell

Tip: Use uv tool install vibelign to skip this entirely โ€” uv handles PATH automatically.


๐Ÿ“– Want to Learn More?

vib manual          # Detailed user guide
vib manual rules    # AI development rules only
vib rules           # Same as above

๐ŸŽฏ Our Promise

"AI coding is fast. But without safety guards, it can destroy what you built."

VibeLign promises:

  • โœ… Save in 1 second (vib checkpoint "description")
  • โœ… Undo in 1 second (vib undo)
  • โœ… No Git knowledge needed
  • โœ… Easy for beginners

โญ If VibeLign saved your code, a Star would mean a lot โ€” thank you!


๐Ÿ“‹ Release Notes

v2.0.0 โ€” Desktop GUI + MCP/Patch Modularization + AI Opt-In:

  • ๐Ÿ–ฅ๏ธ VibeLign GUI (macOS / Windows) โ€” Tauri desktop app
    • Doctor page: one-click diagnosis + auto-apply
    • Anchor card: anchor insertion + intent/aliases regeneration (code-based / AI-based, --force overwrites prior AI results)
    • DocsViewer: per-document AI summarization
    • Settings: API key management, global AI opt-in toggle
  • ๐Ÿ”Œ MCP server refactored โ€” vibelign/mcp/ with dispatch/handlers/tool_specs split
  • ๐Ÿงฉ Patch module split โ€” vibelign/patch/ (builder ยท handoff ยท preview ยท targeting ยท โ€ฆ)
  • ๐Ÿค– AI opt-in โ€” consent UI removed, single global toggle in Settings; Anthropic / OpenAI / Gemini auto-selected
  • โšก onedir runtime โ€” PyInstaller onefile โ†’ onedir removes GUI cold-start (1โ€“3 s โ†’ instant)
  • ๐Ÿท๏ธ Anchor _source field โ€” anchor_meta.json now tracks code / ai / manual / ai_failed so AI/manual results are protected from code-based regeneration (use --force to override)
  • โš ๏ธ Breaking: vibelign.vib_cli โ†’ vibelign.cli.vib_cli; vibelign.mcp_server โ†’ vibelign.mcp.mcp_server
  • See CHANGELOG.md ยท MIGRATION_v1_to_v2.md

v1.6.0 โ€” MCP Server + AI Development Rules System:

  • vib mcp โ€” MCP (Model Context Protocol) server for Claude Desktop integration
  • vib start โ€” Auto-register VibeLign MCP for Claude Code and Cursor without overwriting existing Cursor MCP servers
  • vib rules โ€” View all AI development rules directly in CLI
  • vib manual rules โ€” Detailed rules manual
  • Anchor intent system โ€” Store intent information in anchors
  • Korean tokenizer โ€” Accurately interpret patch requests in Korean
  • AI_DEV_SYSTEM โ€” Added maintainability/function design rules (Section 6-1, 14)
  • vib scan bug fix โ€” Fixed missing set_intent attribute

v1.5.32 โ€” Checkpoint & Undo UX Overhaul + AI Config File Protection:

  • vib checkpoint โ€” Message prompt support
  • vib undo โ€” Number selection + cancel option [0]
  • vib history โ€” Second-precision timestamps
  • vib start โ€” Beginner onboarding + auto first checkpoint
  • vib export โ€” AGENTS.md, CLAUDE.md, OPENCODE.md, .cursorrules protection

v1.5.0 โ€” Multi-Tool AI Config Export:

  • vib export claude โ€” Generate CLAUDE.md for Claude Code
  • vib export cursor โ€” Generate .cursorrules for Cursor
  • vib export opencode โ€” Generate OPENCODE.md for OpenCode
  • vib export antigravity โ€” Generate AGENTS.md for Codex/agents
  • Added VibeLign markers to exported files (prevent overwriting)

v1.1.0 โ€” Core Features for Beginners:

  • vib init โ€” Initialize/reset VibeLign
  • vib start โ€” First-time user guide
  • vib checkpoint / vib undo โ€” Save & restore without Git
  • vib protect โ€” Lock important files
  • vib ask โ€” Generate AI explanation prompts
  • vib history โ€” View checkpoint history

License

MIT

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

vibelign-2.0.18.tar.gz (398.6 kB view details)

Uploaded Source

Built Distribution

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

vibelign-2.0.18-py3-none-any.whl (359.0 kB view details)

Uploaded Python 3

File details

Details for the file vibelign-2.0.18.tar.gz.

File metadata

  • Download URL: vibelign-2.0.18.tar.gz
  • Upload date:
  • Size: 398.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vibelign-2.0.18.tar.gz
Algorithm Hash digest
SHA256 fe1b8105f651efd0286acf2e247911266a805c3e4aff282b2de1c023b75f48ef
MD5 3420baa764b45ab958c09a7d718808e6
BLAKE2b-256 e5c928c8e172d0c71f0ed4df106a8d72a03bc9c1ea87ca4cafc51d9b9341cc02

See more details on using hashes here.

Provenance

The following attestation bundles were made for vibelign-2.0.18.tar.gz:

Publisher: publish.yml on yesonsys03-web/VibeLign

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vibelign-2.0.18-py3-none-any.whl.

File metadata

  • Download URL: vibelign-2.0.18-py3-none-any.whl
  • Upload date:
  • Size: 359.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for vibelign-2.0.18-py3-none-any.whl
Algorithm Hash digest
SHA256 aaaedd4fe739dc07032bb72d6e552d7f956e987b816bd4d15fd9f6a2e9cda136
MD5 9668ca116fd6f836723fc0c6f3a80204
BLAKE2b-256 12fe5c4c20b9455f85be4afcf04b099b048b5c82a33cd99836dc06d5946c2a5a

See more details on using hashes here.

Provenance

The following attestation bundles were made for vibelign-2.0.18-py3-none-any.whl:

Publisher: publish.yml on yesonsys03-web/VibeLign

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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