@nclamvn/vibecode-cli 1.6.0 → 1.8.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.
Files changed (70) hide show
  1. package/bin/vibecode.js +101 -1
  2. package/docs-site/README.md +41 -0
  3. package/docs-site/blog/2019-05-28-first-blog-post.md +12 -0
  4. package/docs-site/blog/2019-05-29-long-blog-post.md +44 -0
  5. package/docs-site/blog/2021-08-01-mdx-blog-post.mdx +24 -0
  6. package/docs-site/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg +0 -0
  7. package/docs-site/blog/2021-08-26-welcome/index.md +29 -0
  8. package/docs-site/blog/authors.yml +25 -0
  9. package/docs-site/blog/tags.yml +19 -0
  10. package/docs-site/docs/commands/agent.md +162 -0
  11. package/docs-site/docs/commands/assist.md +71 -0
  12. package/docs-site/docs/commands/build.md +53 -0
  13. package/docs-site/docs/commands/config.md +30 -0
  14. package/docs-site/docs/commands/debug.md +173 -0
  15. package/docs-site/docs/commands/doctor.md +34 -0
  16. package/docs-site/docs/commands/go.md +128 -0
  17. package/docs-site/docs/commands/index.md +79 -0
  18. package/docs-site/docs/commands/init.md +42 -0
  19. package/docs-site/docs/commands/learn.md +82 -0
  20. package/docs-site/docs/commands/lock.md +33 -0
  21. package/docs-site/docs/commands/plan.md +29 -0
  22. package/docs-site/docs/commands/review.md +31 -0
  23. package/docs-site/docs/commands/snapshot.md +34 -0
  24. package/docs-site/docs/commands/start.md +32 -0
  25. package/docs-site/docs/commands/status.md +37 -0
  26. package/docs-site/docs/commands/undo.md +83 -0
  27. package/docs-site/docs/configuration.md +72 -0
  28. package/docs-site/docs/faq.md +83 -0
  29. package/docs-site/docs/getting-started.md +119 -0
  30. package/docs-site/docs/guides/agent-mode.md +94 -0
  31. package/docs-site/docs/guides/debug-mode.md +83 -0
  32. package/docs-site/docs/guides/magic-mode.md +107 -0
  33. package/docs-site/docs/installation.md +98 -0
  34. package/docs-site/docs/intro.md +67 -0
  35. package/docs-site/docusaurus.config.ts +141 -0
  36. package/docs-site/package-lock.json +18039 -0
  37. package/docs-site/package.json +48 -0
  38. package/docs-site/sidebars.ts +70 -0
  39. package/docs-site/src/components/HomepageFeatures/index.tsx +72 -0
  40. package/docs-site/src/components/HomepageFeatures/styles.module.css +16 -0
  41. package/docs-site/src/css/custom.css +30 -0
  42. package/docs-site/src/pages/index.module.css +23 -0
  43. package/docs-site/src/pages/index.tsx +44 -0
  44. package/docs-site/src/pages/markdown-page.md +7 -0
  45. package/docs-site/src/theme/Footer/index.tsx +127 -0
  46. package/docs-site/src/theme/Footer/styles.module.css +285 -0
  47. package/docs-site/static/.nojekyll +0 -0
  48. package/docs-site/static/img/docusaurus-social-card.jpg +0 -0
  49. package/docs-site/static/img/docusaurus.png +0 -0
  50. package/docs-site/static/img/favicon.ico +0 -0
  51. package/docs-site/static/img/logo.svg +1 -0
  52. package/docs-site/static/img/undraw_docusaurus_mountain.svg +171 -0
  53. package/docs-site/static/img/undraw_docusaurus_react.svg +170 -0
  54. package/docs-site/static/img/undraw_docusaurus_tree.svg +40 -0
  55. package/docs-site/tsconfig.json +8 -0
  56. package/package.json +2 -1
  57. package/src/commands/ask.js +230 -0
  58. package/src/commands/debug.js +109 -1
  59. package/src/commands/docs.js +167 -0
  60. package/src/commands/git.js +1024 -0
  61. package/src/commands/migrate.js +341 -0
  62. package/src/commands/refactor.js +205 -0
  63. package/src/commands/review.js +126 -1
  64. package/src/commands/security.js +229 -0
  65. package/src/commands/shell.js +486 -0
  66. package/src/commands/test.js +194 -0
  67. package/src/commands/watch.js +556 -0
  68. package/src/debug/image-analyzer.js +304 -0
  69. package/src/index.js +27 -0
  70. package/src/utils/image.js +222 -0
@@ -0,0 +1,98 @@
1
+ ---
2
+ sidebar_position: 3
3
+ ---
4
+
5
+ # Installation
6
+
7
+ Complete guide to installing Vibecode CLI.
8
+
9
+ ## System Requirements
10
+
11
+ | Requirement | Minimum | Recommended |
12
+ |-------------|---------|-------------|
13
+ | Node.js | 18.0.0 | 20.x LTS |
14
+ | npm | 9.0.0 | Latest |
15
+ | OS | macOS, Linux, Windows | macOS, Linux |
16
+ | RAM | 4 GB | 8 GB+ |
17
+
18
+ ## Install via npm
19
+
20
+ ```bash
21
+ npm install -g @nclamvn/vibecode-cli
22
+ ```
23
+
24
+ ## Install Claude Code (Required for AI features)
25
+
26
+ Vibecode uses Claude Code CLI for AI-powered features:
27
+
28
+ ```bash
29
+ npm install -g @anthropic-ai/claude-code
30
+ ```
31
+
32
+ Set up your Anthropic API key:
33
+ ```bash
34
+ export ANTHROPIC_API_KEY="your-api-key"
35
+ ```
36
+
37
+ ## Verify Installation
38
+
39
+ ```bash
40
+ # Check Vibecode version
41
+ vibecode --version
42
+
43
+ # Check Claude Code
44
+ claude --version
45
+
46
+ # Run doctor to verify setup
47
+ vibecode doctor
48
+ ```
49
+
50
+ ## Updating
51
+
52
+ ```bash
53
+ npm update -g @nclamvn/vibecode-cli
54
+ ```
55
+
56
+ ## Uninstalling
57
+
58
+ ```bash
59
+ npm uninstall -g @nclamvn/vibecode-cli
60
+ ```
61
+
62
+ ## Troubleshooting
63
+
64
+ ### Permission Errors
65
+
66
+ If you get `EACCES` errors:
67
+
68
+ ```bash
69
+ # Option 1: Use npx
70
+ npx @nclamvn/vibecode-cli
71
+
72
+ # Option 2: Fix npm permissions
73
+ mkdir ~/.npm-global
74
+ npm config set prefix '~/.npm-global'
75
+ echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
76
+ source ~/.bashrc
77
+ ```
78
+
79
+ ### Node.js Version Issues
80
+
81
+ ```bash
82
+ # Check version
83
+ node --version
84
+
85
+ # Use nvm to install correct version
86
+ nvm install 20
87
+ nvm use 20
88
+ ```
89
+
90
+ ### Claude Code Not Found
91
+
92
+ ```bash
93
+ # Verify installation
94
+ which claude
95
+
96
+ # Reinstall if needed
97
+ npm install -g @anthropic-ai/claude-code
98
+ ```
@@ -0,0 +1,67 @@
1
+ ---
2
+ sidebar_position: 1
3
+ ---
4
+
5
+ # Introduction
6
+
7
+ **Vibecode CLI** is a command-line tool that helps you build software with AI assistance while maintaining discipline and control.
8
+
9
+ ## What is Vibecode?
10
+
11
+ Vibecode provides a structured workflow for AI-assisted software development:
12
+
13
+ - **Guided Process**: From requirements capture to deployment
14
+ - **AI Integration**: Powered by Claude Code for intelligent code generation
15
+ - **Quality Guardrails**: Built-in testing, review, and rollback capabilities
16
+ - **Learning System**: AI improves from your feedback over time
17
+
18
+ ## Key Features
19
+
20
+ ### Magic Mode (`vibecode go`)
21
+ One command to build an entire project:
22
+ ```bash
23
+ vibecode go "Landing page for my SaaS startup"
24
+ ```
25
+
26
+ ### Agent Mode (`vibecode agent`)
27
+ Multi-module autonomous building with self-healing:
28
+ ```bash
29
+ vibecode agent "E-commerce platform with auth, products, and checkout"
30
+ ```
31
+
32
+ ### Debug Mode (`vibecode debug`)
33
+ Intelligent 9-step bug fixing:
34
+ ```bash
35
+ vibecode debug "TypeError in user authentication"
36
+ ```
37
+
38
+ ### Undo & Learn
39
+ Auto-backup with rollback, and AI that learns from your feedback:
40
+ ```bash
41
+ vibecode undo --list
42
+ vibecode learn --stats
43
+ ```
44
+
45
+ ## Quick Start
46
+
47
+ ```bash
48
+ # Install globally
49
+ npm install -g @nclamvn/vibecode-cli
50
+
51
+ # Run interactive wizard
52
+ vibecode
53
+
54
+ # Or start with Magic Mode
55
+ vibecode go "Your project description"
56
+ ```
57
+
58
+ ## Requirements
59
+
60
+ - Node.js 18.0.0 or higher
61
+ - Claude Code CLI (`npm install -g @anthropic-ai/claude-code`)
62
+
63
+ ## Next Steps
64
+
65
+ - [Getting Started](./getting-started) - First steps with Vibecode
66
+ - [Installation](./installation) - Detailed installation guide
67
+ - [Commands](./commands) - All available commands
@@ -0,0 +1,141 @@
1
+ import {themes as prismThemes} from 'prism-react-renderer';
2
+ import type {Config} from '@docusaurus/types';
3
+ import type * as Preset from '@docusaurus/preset-classic';
4
+
5
+ const config: Config = {
6
+ title: 'Vibecode CLI',
7
+ tagline: 'Build software with discipline - AI coding with guardrails',
8
+ favicon: 'img/favicon.ico',
9
+
10
+ future: {
11
+ v4: true,
12
+ },
13
+
14
+ url: 'https://vibecode.dev',
15
+ baseUrl: '/',
16
+
17
+ organizationName: 'nclamvn',
18
+ projectName: 'vibecode-cli',
19
+
20
+ onBrokenLinks: 'throw',
21
+
22
+ i18n: {
23
+ defaultLocale: 'en',
24
+ locales: ['en', 'vi'],
25
+ },
26
+
27
+ presets: [
28
+ [
29
+ 'classic',
30
+ {
31
+ docs: {
32
+ sidebarPath: './sidebars.ts',
33
+ editUrl: 'https://github.com/nclamvn/vibecode-cli/tree/main/docs-site/',
34
+ },
35
+ blog: false, // Disable blog for now
36
+ theme: {
37
+ customCss: './src/css/custom.css',
38
+ },
39
+ } satisfies Preset.Options,
40
+ ],
41
+ ],
42
+
43
+ themeConfig: {
44
+ image: 'img/vibecode-social-card.png',
45
+ colorMode: {
46
+ defaultMode: 'dark',
47
+ respectPrefersColorScheme: true,
48
+ },
49
+ navbar: {
50
+ title: 'Vibecode',
51
+ logo: {
52
+ alt: 'Vibecode Logo',
53
+ src: 'img/logo.svg',
54
+ },
55
+ items: [
56
+ {
57
+ type: 'docSidebar',
58
+ sidebarId: 'docsSidebar',
59
+ position: 'left',
60
+ label: 'Docs',
61
+ },
62
+ {
63
+ href: '/docs/commands',
64
+ label: 'Commands',
65
+ position: 'left',
66
+ },
67
+ {
68
+ href: 'https://www.npmjs.com/package/@nclamvn/vibecode-cli',
69
+ label: 'npm',
70
+ position: 'right',
71
+ },
72
+ {
73
+ href: 'https://github.com/nclamvn/vibecode-cli',
74
+ label: 'GitHub',
75
+ position: 'right',
76
+ },
77
+ ],
78
+ },
79
+ footer: {
80
+ style: 'dark',
81
+ links: [
82
+ {
83
+ title: 'Documentation',
84
+ items: [
85
+ {
86
+ label: 'Getting Started',
87
+ to: '/docs/getting-started',
88
+ },
89
+ {
90
+ label: 'Commands',
91
+ to: '/docs/commands',
92
+ },
93
+ {
94
+ label: 'Configuration',
95
+ to: '/docs/configuration',
96
+ },
97
+ ],
98
+ },
99
+ {
100
+ title: 'Quick Links',
101
+ items: [
102
+ {
103
+ label: 'Magic Mode (go)',
104
+ to: '/docs/commands/go',
105
+ },
106
+ {
107
+ label: 'Agent Mode',
108
+ to: '/docs/commands/agent',
109
+ },
110
+ {
111
+ label: 'Debug Mode',
112
+ to: '/docs/commands/debug',
113
+ },
114
+ ],
115
+ },
116
+ {
117
+ title: 'More',
118
+ items: [
119
+ {
120
+ label: 'npm Package',
121
+ href: 'https://www.npmjs.com/package/@nclamvn/vibecode-cli',
122
+ },
123
+ {
124
+ label: 'GitHub',
125
+ href: 'https://github.com/nclamvn/vibecode-cli',
126
+ },
127
+ ],
128
+ },
129
+ ],
130
+ copyright: `Copyright © ${new Date().getFullYear()} Vibecode. Built with Docusaurus.`,
131
+ },
132
+ prism: {
133
+ theme: prismThemes.github,
134
+ darkTheme: prismThemes.dracula,
135
+ additionalLanguages: ['bash', 'json'],
136
+ },
137
+ algolia: undefined, // Add Algolia later for search
138
+ } satisfies Preset.ThemeConfig,
139
+ };
140
+
141
+ export default config;