Skip to content

Commit a6da8db

Browse files
committed
chore: bump version to 0.7.0 and update README
Bump version for the new integration module system. Move documentation link to top of README, update platform listings and commands section to reflect all 8 supported platforms and bridge files.
1 parent a571184 commit a6da8db

2 files changed

Lines changed: 39 additions & 34 deletions

File tree

README.md

Lines changed: 38 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,12 @@
22

33
> Context Engineering for AI Development
44
5-
Give your AI assistants (Cursor, Claude, VS Code Copilot, Aider) structured context through markdown files. Vibe Kit creates a knowledge base that ensures AI generates code matching your exact patterns, style, and architecture—no more hallucinated code or mismatched conventions.
5+
Give your AI assistants (Cursor, Claude, Copilot, Codex, Gemini, Aider, Continue, Windsurf) structured context through markdown files. Vibe Kit creates a knowledge base that ensures AI generates code matching your exact patterns, style, and architecture—no more hallucinated code or mismatched conventions.
66

77
Vibe Kit is a CLI tool that provides **context-engineering** capabilities by creating `.vibe-kit/` directories with project standards, guidelines, and patterns that AI assistants read automatically.
88

9+
**[Read the full documentation](https://vibe-kit-docs.vercel.app/)**
10+
911
## Why Vibe Kit?
1012

1113
**The problem:** LLMs are great at syntax, not at *your* conventions. Generic AI output requires manual fixes for style, structure, and architecture.
@@ -19,7 +21,9 @@ Update `.md` files as your project evolves; the AI follows.
1921

2022
## Multi-Platform Support
2123

22-
Works with: **Cursor** (auto) • **VS Code** (`@.vibe-kit`) • **Claude CLI****Codex CLI****Aider****Continue****Gemini CLI**
24+
Works with: **Cursor****Claude Code****GitHub Copilot****Codex CLI****Gemini CLI****Aider****Continue****Windsurf**
25+
26+
Each platform gets auto-loaded bridge files (`CLAUDE.md`, `AGENTS.md`, `GEMINI.md`, `.windsurfrules`, etc.) so your AI tools read project standards automatically.
2327

2428
---
2529

@@ -66,20 +70,19 @@ Perfect for teams where members use different AI tools:
6670
# First team member (any tool) - sets up the project
6771
vibe-kit install
6872

69-
# Cursor users add their integration
70-
vibe-kit cursor # or: vk cursor
71-
72-
# Claude users add their integration
73-
vibe-kit claude # or: vk claude
74-
75-
# Codex users add their integration
76-
vibe-kit codex # or: vk codex
77-
78-
# VS Code users add their integration
79-
vibe-kit vscode # or: vk vscode
73+
# Each team member adds their platform
74+
vk claude # creates CLAUDE.md + .claude/rules/
75+
vk cursor # creates .cursor/rules/ (scoped .mdc files)
76+
vk copilot # creates .github/copilot-instructions.md
77+
vk codex # creates AGENTS.md
78+
vk gemini # creates GEMINI.md + .gemini/settings.json
79+
vk aider # creates CONVENTIONS.md + .aider/rules.md
80+
vk continue # creates .continue/rules/ + config.yaml
81+
vk windsurf # creates .windsurfrules + .windsurf/rules/
82+
vk vscode # alias for copilot
8083
```
8184

82-
Each platform integration is added to `.vibe-kit/` without overwriting existing files. Share your analyzed `.vibe-kit/standards/*.md` files with the team and everyone gets the same context.
85+
Each platform generates bridge files that the AI tool auto-reads. If a bridge file already exists (e.g., you have a custom `CLAUDE.md`), Vibe Kit appends its section below your content instead of overwriting. Share your `.vibe-kit/standards/*.md` files with the team and everyone gets the same context.
8386

8487
---
8588

@@ -108,24 +111,29 @@ Each platform integration is added to `.vibe-kit/` without overwriting existing
108111

109112
## Use it in your tool
110113

111-
**Cursor** (AI chat)
114+
**Cursor** — rules auto-load from `.cursor/rules/`
112115
```
113116
@.vibe-kit/commands/analyze.md
114117
```
115118

116-
**VS Code** (Copilot Chat)
119+
**Claude Code** — reads `CLAUDE.md` + `.claude/rules/` automatically
120+
```bash
121+
claude "create checkout flow for customer"
122+
```
123+
124+
**GitHub Copilot** — reads `.github/copilot-instructions.md` automatically
117125
```
118126
@.vibe-kit Create checkout flow for customer
119127
```
120128

121-
**CLI** (Chat with AI)
129+
**Codex CLI** — reads `AGENTS.md` automatically
122130
```bash
123-
vk ai "create checkout flow for customer"
131+
codex "create checkout flow for customer"
124132
```
125133

126-
**Claude / Gemini / Codex / Aider** (Direct context)
127-
```
128-
read .vibe-kit/commands/analyze.md and execute
134+
**CLI** (Chat with AI)
135+
```bash
136+
vk ai "create checkout flow for customer"
129137
```
130138

131139
---
@@ -135,7 +143,7 @@ read .vibe-kit/commands/analyze.md and execute
135143
- 🧠 **Context Engineering** - Structured MD files your AI reads automatically
136144
- 🔍 **Smart Analysis** - AI generates standards content based on your codebase
137145
- 🌍 **Project Agnostic** - Works with React, Vue, Node.js, PHP, Python, Rust, monorepos—any project type
138-
- 🤖 **Multi-Platform** - Works with Cursor, Claude CLI, Codex CLI, Aider, Continue, VS Code, Gemini
146+
- 🤖 **Multi-Platform** - Works with Cursor, Claude Code, Copilot, Codex, Gemini, Aider, Continue, Windsurf
139147
- 🛡️ **Safe Install** - Backs up existing files with rollback support
140148
-**Zero Config** - Auto-detects package managers and AI tools
141149
-**Policy Enforcement** - Configurable validation with `vk check`
@@ -149,13 +157,15 @@ read .vibe-kit/commands/analyze.md and execute
149157
```bash
150158
# Installation & Setup
151159
vk install # set up .vibe-kit in this repo
152-
vk cursor # add Cursor integration
160+
vk claude # add Claude Code integration (CLAUDE.md + rules)
161+
vk cursor # add Cursor integration (scoped .mdc rules)
162+
vk copilot # add GitHub Copilot integration
163+
vk codex # add Codex CLI integration (AGENTS.md)
164+
vk gemini # add Gemini CLI integration (GEMINI.md)
165+
vk aider # add Aider integration (CONVENTIONS.md)
153166
vk continue # add Continue integration
154-
vk aider # add Aider integration
155-
vk vscode # add VS Code integration
156-
vk claude # add Claude CLI integration
157-
vk codex # add Codex CLI integration
158-
vk gemini # add Gemini CLI integration
167+
vk windsurf # add Windsurf integration (.windsurfrules)
168+
vk vscode # alias for copilot
159169

160170
# Analysis & Updates
161171
vk analyze # customize standards to your project
@@ -189,13 +199,8 @@ vk "create a button" # quick AI chat with context
189199
vk ai "create a button" # explicit AI command
190200
```
191201

192-
See [full documentation](https://vibe-kit-docs.vercel.app/) for detailed guides.
193-
194-
---
195-
196202
## Links
197203

198-
• 📚 [Full Documentation](https://vibe-kit-docs.vercel.app/)
199204
• 🐛 [Issues](https://github.com/nolrm/vibe-kit/issues)
200205
• 💬 [Discussions](https://github.com/nolrm/vibe-kit/discussions)
201206

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nolrm/vibe-kit",
3-
"version": "0.6.1",
3+
"version": "0.7.0",
44
"description": "Context Engineering for AI Development - Provide rich context to AI through structured MD files with standards, code guides, and documentation. Works with Cursor, Claude, Aider, VS Code Copilot, and more.",
55
"main": "lib/index.js",
66
"bin": {

0 commit comments

Comments
 (0)