start-vibing 1.1.11 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,149 +1,176 @@
1
- # start-vibing
2
-
3
- > Setup Claude Code agents, skills, and hooks in your project with a single command.
4
-
5
- ## Quick Start
6
-
7
- ```bash
8
- # Using npx
9
- npx start-vibing
10
-
11
- # Using bunx (faster)
12
- bunx start-vibing
13
- ```
14
-
15
- ## What It Does
16
-
17
- Sets up a complete Claude Code development workflow in your project:
18
-
19
- ```
20
- .claude/
21
- ├── agents/ # 11 specialized AI agents
22
- │ ├── orchestrator.md # Coordinates workflow
23
- │ ├── analyzer.md # Analyzes change impact
24
- │ ├── research.md # Researches best practices
25
- │ ├── tester.md # Creates tests (Playwright + Vitest)
26
- │ ├── security-auditor.md # Security audit (VETO power)
27
- │ ├── quality-checker.md # Quality gates
28
- │ └── ...
29
- ├── skills/ # 8 skill systems
30
- │ ├── test-coverage/ # E2E testing templates
31
- │ ├── security-scan/ # OWASP validation
32
- │ ├── codebase-knowledge/ # Domain mapping
33
- │ └── ...
34
- ├── hooks/ # Workflow enforcement
35
- │ ├── pre-tool-use.py # Blocks unapproved edits
36
- │ ├── post-tool-use.py # Tracks modifications
37
- │ ├── stop-validation.py # Blocks incomplete work
38
- │ └── workflow-manager.py # CLI for state tracking
39
- └── config/ # Project configuration
40
- ├── project-config.json
41
- ├── quality-gates.json
42
- └── ...
43
- ```
44
-
45
- ## Features
46
-
47
- ### 11 Specialized Agents
48
-
49
- | Agent | Purpose | VETO |
50
- | ---------------- | --------------------------- | ---- |
51
- | orchestrator | Coordinates entire workflow | No |
52
- | analyzer | Analyzes change impact | No |
53
- | research | Best practices research | No |
54
- | documenter | Documentation updates | No |
55
- | tester | Unit + E2E tests | No |
56
- | security-auditor | Security audit | Yes |
57
- | ui-ux-reviewer | UI/UX review | No |
58
- | quality-checker | Quality gates | No |
59
- | final-validator | Final validation | Yes |
60
- | domain-updater | Domain knowledge | No |
61
- | commit-manager | Git commits | No |
62
-
63
- ### Smart Copy Behavior
64
-
65
- When you run `start-vibing` in an existing project:
66
-
67
- - **ALWAYS overwrites:** Agent files, hooks, settings.json
68
- - **PRESERVES:** Your custom domains, cached research
69
- - **MERGES:** New skills with existing ones
70
-
71
- Use `--force` to overwrite everything.
72
-
73
- ### Workflow Enforcement
74
-
75
- Hooks enforce the workflow:
76
-
77
- 1. **pre-tool-use.py** - Blocks file edits without approved task
78
- 2. **post-tool-use.py** - Auto-tracks all modifications
79
- 3. **stop-validation.py** - Blocks incomplete workflows
80
-
81
- ## Usage
82
-
83
- ### First Setup
84
-
85
- ```bash
86
- cd your-project
87
- npx start-vibing
88
- ```
89
-
90
- ### Update to Latest
91
-
92
- ```bash
93
- npx start-vibing --force
94
- ```
95
-
96
- ### After Setup
97
-
98
- ```bash
99
- # 1. Configure your project
100
- edit .claude/config/project-config.json
101
-
102
- # 2. Start a task
103
- python .claude/hooks/workflow-manager.py start-task --type feature --description "Add feature X"
104
-
105
- # 3. Work with Claude Code
106
- # The agents will guide you through the workflow
107
- ```
108
-
109
- ## Configuration
110
-
111
- After setup, edit `.claude/config/project-config.json`:
112
-
113
- ```json
114
- {
115
- "stack": {
116
- "runtime": "bun",
117
- "language": "typescript",
118
- "database": "mongodb"
119
- },
120
- "commands": {
121
- "typecheck": "bun run typecheck",
122
- "lint": "bun run lint",
123
- "test": "bun run test",
124
- "build": "bun run build"
125
- }
126
- }
127
- ```
128
-
129
- ## Options
130
-
131
- | Flag | Description |
132
- | ----------- | ------------------------------ |
133
- | `--force` | Overwrite all files |
134
- | `--help` | Show help message |
135
- | `--version` | Show version |
136
-
137
- ## Requirements
138
-
139
- - Node.js >= 18 or Bun
140
- - Python 3.x (for hooks)
141
-
142
- ## License
143
-
144
- MIT
145
-
146
- ## Links
147
-
148
- - [Claude Code Documentation](https://docs.claude.dev)
149
- - [Report Issues](https://github.com/joaov/start-vibing/issues)
1
+ # start-vibing
2
+
3
+ > One command to set up Claude Code with a complete AI development workflow.
4
+
5
+ ## Quick Start
6
+
7
+ ```bash
8
+ # Just run this in any project
9
+ npx start-vibing
10
+ ```
11
+
12
+ That's it! The CLI will:
13
+ 1. Check for updates
14
+ 2. Set up the `.claude/` folder with agents, skills, and hooks
15
+ 3. Install Claude Code if not found on your system
16
+ 4. Launch Claude Code with `--dangerously-skip-permissions`
17
+
18
+ ## Installation
19
+
20
+ ### Recommended: Install Globally
21
+
22
+ ```bash
23
+ npm install -g start-vibing
24
+ ```
25
+
26
+ Then just run `start-vibing` in any project.
27
+
28
+ ### Or use npx/bunx
29
+
30
+ ```bash
31
+ npx start-vibing # npm
32
+ bunx start-vibing # bun (faster)
33
+ ```
34
+
35
+ ## What It Does
36
+
37
+ ### 1. Auto-installs Claude Code
38
+
39
+ If Claude Code is not found on your system, it automatically installs using official methods:
40
+
41
+ | Platform | Installation Command |
42
+ |----------|---------------------|
43
+ | macOS/Linux | `curl -fsSL https://claude.ai/install.sh \| bash` |
44
+ | Windows (PowerShell) | `irm https://claude.ai/install.ps1 \| iex` |
45
+ | Windows (CMD) | Downloads and runs `install.cmd` |
46
+
47
+ ### 2. Sets Up Complete Workflow
48
+
49
+ Creates a `.claude/` folder with:
50
+
51
+ ```
52
+ .claude/
53
+ ├── agents/ # 14 specialized AI agents
54
+ │ ├── orchestrator.md # Coordinates workflow
55
+ │ ├── analyzer.md # Analyzes change impact
56
+ │ ├── research.md # Researches best practices
57
+ │ ├── code-reviewer.md # Reviews code quality
58
+ │ ├── tester.md # Creates tests
59
+ │ ├── security-auditor.md # Security audit (VETO power)
60
+ ├── performance.md # Performance optimization
61
+ ├── debugger.md # Bug tracing
62
+ │ └── ...
63
+ ├── skills/ # 8 skill systems with progressive disclosure
64
+ │ ├── test-coverage/ # E2E testing (Playwright)
65
+ │ ├── security-scan/ # OWASP validation + scripts
66
+ │ ├── quality-gate/ # Quality checks + scripts
67
+ │ └── ...
68
+ ├── hooks/ # Workflow enforcement
69
+ │ └── stop-validator.py # Blocks incomplete work
70
+ └── config/ # Project configuration
71
+ └── project-config.json
72
+ ```
73
+
74
+ ### 3. Auto-launches Claude Code
75
+
76
+ After setup, automatically runs `claude --dangerously-skip-permissions` so you can start working immediately.
77
+
78
+ ### 4. Self-updates
79
+
80
+ Checks for updates on every run (cached for 1 hour) and notifies you when a new version is available.
81
+
82
+ ## Features
83
+
84
+ ### 14 Specialized Agents
85
+
86
+ | Agent | Purpose | VETO |
87
+ | ---------------- | --------------------------- | ---- |
88
+ | orchestrator | Coordinates entire workflow | No |
89
+ | analyzer | Analyzes change impact | No |
90
+ | research | Best practices research | No |
91
+ | code-reviewer | Reviews code quality | No |
92
+ | documenter | Documentation updates | No |
93
+ | tester | Unit + E2E tests | No |
94
+ | security-auditor | Security audit | Yes |
95
+ | ui-ux-reviewer | UI/UX review | No |
96
+ | quality-checker | Quality gates | No |
97
+ | performance | Performance optimization | No |
98
+ | debugger | Bug tracing | No |
99
+ | final-validator | Final validation | Yes |
100
+ | domain-updater | Domain knowledge | No |
101
+ | commit-manager | Git commits | No |
102
+
103
+ ### Smart Copy Behavior
104
+
105
+ When you run `start-vibing` in an existing project:
106
+
107
+ - **ALWAYS overwrites:** Agent files, hooks, settings.json
108
+ - **PRESERVES:** Your custom domains, cached research
109
+ - **MERGES:** New skills with existing ones
110
+
111
+ Use `--force` to overwrite everything.
112
+
113
+ ## CLI Options
114
+
115
+ | Flag | Description |
116
+ | ------------------ | ---------------------------------------- |
117
+ | `--force` | Overwrite all files |
118
+ | `--no-claude` | Skip Claude Code installation and launch |
119
+ | `--no-update-check`| Skip checking for updates |
120
+ | `--help`, `-h` | Show help message |
121
+ | `--version`, `-v` | Show version |
122
+
123
+ ## After Setup
124
+
125
+ ```bash
126
+ # 1. Configure your project
127
+ edit .claude/config/project-config.json
128
+
129
+ # 2. Claude Code is already running!
130
+ # The agents will guide you through the workflow
131
+ ```
132
+
133
+ ### Configuration
134
+
135
+ Edit `.claude/config/project-config.json`:
136
+
137
+ ```json
138
+ {
139
+ "stack": {
140
+ "runtime": "bun",
141
+ "language": "typescript",
142
+ "database": "mongodb"
143
+ },
144
+ "commands": {
145
+ "typecheck": "bun run typecheck",
146
+ "lint": "bun run lint",
147
+ "test": "bun run test",
148
+ "build": "bun run build"
149
+ }
150
+ }
151
+ ```
152
+
153
+ ## Requirements
154
+
155
+ - Node.js >= 18 or Bun
156
+ - Internet connection (for Claude Code installation if needed)
157
+
158
+ ## Platforms
159
+
160
+ | Platform | Status |
161
+ |----------|--------|
162
+ | macOS | Fully supported |
163
+ | Linux | Fully supported |
164
+ | Windows (PowerShell) | Fully supported |
165
+ | Windows (CMD) | Fully supported |
166
+ | Windows (WSL) | Fully supported |
167
+
168
+ ## License
169
+
170
+ MIT
171
+
172
+ ## Links
173
+
174
+ - [Claude Code Documentation](https://docs.anthropic.com/claude-code)
175
+ - [GitHub Repository](https://github.com/LimaTechnologies/ai-development)
176
+ - [Report Issues](https://github.com/LimaTechnologies/ai-development/issues)