Skip to content

8bitAlex/VibeCheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VibeCheck

An AI mentor for people who build software with AI — even if they've never written code before.

VibeCheck is a prompt you add to your AI coding tool (Cursor, Claude, ChatGPT). It turns your AI into a patient mentor that helps you figure out what to build, designs it with you, keeps your project safe, and guides you all the way to shipping it.

Not an app. Not a wrapper. Just a prompt that makes your AI tools work with you instead of just for you.


What VibeCheck Does

  • Interviews you about your project idea before you write any code — helps you figure out what to build, how big it really is, and what to tackle first
  • Creates a project plan (VIBECHECK.md) with your goals, features, and requirements so nothing gets lost
  • Guides you through development — explains things in plain language, makes decisions for you when you're unsure, and checks your work as you go
  • Keeps you safe — automatically handles security best practices so you don't have to think about it
  • Prevents scope creep — reminds you what you agreed to build and flags when you're drifting
  • Walks you through deployment — helps you put your project on the internet when it's ready
  • Tells you when to ship — helps you recognize "good enough" instead of tweaking forever

Quick Start

Pick the tool you're using and follow the steps. It takes about 30 seconds.

Cursor

Run this in your terminal (the black window with text — if you don't have one open, ask your AI tool to help):

curl -fsSL https://raw.githubusercontent.com/8bitalex/vibecheck/main/prompts/vibecheck.mdc -o .cursor/rules/vibecheck.mdc --create-dirs

Or manually: download vibecheck.mdc and put it in your project's .cursor/rules/ folder.

That's it. VibeCheck is now active in every conversation in that project.

VS Code (Copilot)

Run this in your project directory:

curl -fsSL https://raw.githubusercontent.com/8bitalex/vibecheck/main/prompts/core.md -o .github/copilot-instructions.md --create-dirs

Or manually: create .github/copilot-instructions.md in your project and paste in the contents of core.md. Copilot will follow the instructions automatically.

Claude.ai

Copy the prompt to your clipboard:

curl -fsSL https://raw.githubusercontent.com/8bitalex/vibecheck/main/prompts/claude-project.md | pbcopy

Then go to claude.aiProjectsCreate ProjectProject Instructions → paste → start chatting.

Or manually: copy everything from claude-project.md and paste it in.

ChatGPT

Copy the prompt to your clipboard:

curl -fsSL https://raw.githubusercontent.com/8bitalex/vibecheck/main/prompts/custom-gpt.md | pbcopy

Then go to ChatGPTExplore GPTsCreate → paste into Instructions → save.

Or manually: copy everything from custom-gpt.md and paste it into the Instructions field.

Other AI Tools

Copy the prompt to your clipboard:

curl -fsSL https://raw.githubusercontent.com/8bitalex/vibecheck/main/prompts/core.md | pbcopy

Paste it into your tool's system prompt, custom instructions, or project settings. VibeCheck works with any AI tool that supports custom instructions.


For Developers

If you're a developer sharing this with a non-technical friend, family member, or colleague who's getting into vibe coding — here's what you should know:

What it actually is

A system prompt (~3K tokens minified) that transforms any LLM session into a structured mentorship experience. It enforces an interview-first workflow, generates a local project memory doc (VIBECHECK.md), and maintains security/scope/quality guardrails throughout development.

What it enforces

  • SRP + DRY in all generated code
  • 95% test coverage target — tests are never optional
  • Security by default — secrets management, input validation, auth, HTTPS, rate limiting, no hardcoded credentials
  • Scope management — MVP-first approach with explicit future scope tracking
  • Dependency hygiene — favors well-maintained packages, flags advisories
  • Accessibility — mandatory for public-facing projects
  • Version control habits — commit often, push to remote

Architecture

prompts/
├── core.md              # Canonical source (human-readable)
├── vibecheck.mdc        # Cursor rules (minified, YAML frontmatter)
├── claude-project.md    # Claude.ai Project Instructions (minified)
└── custom-gpt.md        # ChatGPT Custom GPT (minified)
site/
└── index.html           # Landing page (vibecheckme.dev)
.github/workflows/
└── deploy.yml           # GitHub Pages deployment

core.md is the source of truth. Platform variants are minified derivations that preserve full intent. Changes flow outward from core.

Contributing

PRs welcome — the prompt is the product. If you find a security pattern VibeCheck should catch, a scope question it should ask, or a mentorship gap, open an issue or PR against prompts/core.md.


License

MIT

About

A prompt-based AI mentor for vibe coders — turns Cursor, Claude, ChatGPT, or Copilot into a structured guide that interviews you, plans your project, enforces quality & security, and helps you ship. No app. No wrapper. Just a prompt.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages