@vibe-coder/cli 1.0.1 → 1.0.3

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
@@ -2,160 +2,154 @@
2
2
 
3
3
  # 🌊 Vibe Coding CLI
4
4
 
5
- **A vibe coding ecosystem builder tailored for OpenCode**
5
+ **The vibe coding ecosystem builder, specifically designed for OpenCode.**
6
+
7
+ [![vibe-coding: enabled](https://img.shields.io/badge/vibe--coding-enabled-BD00FF?style=flat-square&logo=github&logoColor=white&labelColor=2D3748)](https://github.com/HelloGGX/vibe-coding-cli)
8
+ [![npm version](https://img.shields.io/npm/v/@vibe-coder/cli.svg?style=flat-square)](https://www.npmjs.com/package/@vibe-coder/cli)
9
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](../../LICENSE.md)
10
+ [![Built with Bun](https://img.shields.io/badge/Bun-%23000000.svg?style=flat-square&logo=bun&logoColor=white)](https://bun.sh)
6
11
 
7
12
  **English** · [简体中文](https://github.com/HelloGGX/skill/blob/main/packages/vibe/README.zh.md)
8
13
 
14
+ > *One-click aggregation of AI tools and contextual rules, enabling Agents to truly understand your codebase architecture.*
15
+
9
16
  </div>
10
17
 
11
18
  ## 📖 Introduction
12
19
 
13
- `vibe-coding-cli` is a modern command-line scaffolding tool built specifically for the **OpenCode** platform. Its core objective is to quickly set up a Vibe Coding development environment and simplify resource management for specification-driven development.
20
+ `@vibe-coder/cli` is a modern command-line scaffolding tool built specifically for the **OpenCode** platform. Its core mission is to quickly set up a Vibe Coding development environment and simplify resource management for rule-driven development.
14
21
 
15
- With the `vibe` command, you can pull TypeScript/Python tool scripts or Markdown rule files from remote GitHub repositories with a single click. It automatically and seamlessly registers them into your OpenCode configuration and manages the underlying runtime dependency environments, allowing you to focus entirely on "co-creating code with AI".
22
+ With the `vibe` command, you can pull TypeScript/Python tool scripts or Markdown rule files from remote GitHub repositories with a single click. These are seamlessly and automatically registered into your OpenCode configuration while managing underlying runtime dependencies, allowing you to focus entirely on **"co-creating code with AI."**
16
23
 
17
24
  ## ✨ Features
18
25
 
19
- * 🛠 **Fully Automated Tool Management:** Quickly parse, select, and download `.ts` / `.py` scripts from any GitHub repository straight to your local `.opencode/tool/` directory, ready to use out of the box.
20
- * 📜 **Integrates Everything You Need for Vibe Coding:** A unique ecosystem aggregation capability that perfectly blends the **Capabilities (tools and skills)** needed for Agent execution with the **Context (guidelines and best practices)**. Supports on-demand installation of `.md` rule files so the AI truly understands your architectural intent and coding standards.
21
- * 📦 **Smart Configuration Injection:** Automatically intercepts and updates `.opencode/opencode.jsonc`, silently injecting tool enable-switches and Prompt instruction paths. Say goodbye to tedious manual configuration forever.
22
- * ⚡ **Lightning-Fast Parallel Updates:** Designed with a concurrency model to simultaneously handle resource comparison and pulling from multiple source repositories, drastically reducing update wait times in multi-dependency scenarios.
23
- * 🪄 **Standard Skills Aggregation:** Deeply integrated with Vercel's `pnpx skills` ecosystem, allowing you to manage standard Agent skill libraries alongside localized extension resources within a unified CLI workflow.
26
+ * 🛠 **Fully Automated Tool Management**: Rapidly parse, multi-select, and download `.ts` / `.py` scripts from any GitHub repository for out-of-the-box local usage.
27
+ * 📜 **Perfect Fusion of Context and Capabilities**: Innovative ecosystem aggregation that deeply binds the **tool skills** required by Agents with your **behavioral guidelines**. Supports on-demand installation of `.md` rule files, ensuring AI truly understands your architectural intent.
28
+ * 📦 **Smart Configuration Injection**: Automatically intercepts and updates `.opencode/opencode.jsonc`, silently injecting tool toggles and prompt directive paths. Say goodbye to tedious manual configuration.
29
+ * ⚡ **Blazing Fast Parallel Updates**: Designed with a concurrency model to simultaneously process resource comparisons and pulls across multiple source repositories, drastically reducing update wait times.
30
+ * 🪄 **Standard Skill Aggregation**: Deeply integrated with Vercel's `pnpx skills` ecosystem, allowing you to manage both standard Agent skill libraries and local extension resources within a unified CLI workflow.
24
31
 
25
32
  ---
26
33
 
27
34
  ## 🚀 Quick Start
28
35
 
36
+ ### Prerequisites
37
+
38
+ * [Node.js](https://nodejs.org/) >= 18.0.0 or [Bun](https://bun.sh/) >= 1.0.0
39
+
29
40
  ### Installation
30
41
 
31
- Install as a global package (npm or bun recommended):
42
+ Install globally:
32
43
 
33
44
  ```bash
34
45
  # Using npm
35
- npm install -g vibe-coding-cli
46
+ npm i -g @vibe-coder/cli
36
47
 
37
48
  # Using bun
38
- bun add -g vibe-coding-cli
39
-
49
+ bun add -g @vibe-coder/cli
40
50
  ```
41
51
 
42
52
  ### Basic Usage
43
53
 
44
- Initialize and add an ecosystem library (e.g., `helloggx/skill` from this project):
54
+ Initialize and add an ecosystem repository (e.g., `helloggx/skill` from this project):
45
55
 
46
56
  ```bash
47
57
  vibe add helloggx/skill
48
-
49
58
  ```
50
59
 
51
- *This command will pop up an interactive menu, allowing you to flexibly select the **Tools** and **Rules** you want to install. The CLI will automatically configure the entire environment for you.*
60
+ *The CLI will launch an interactive menu, allowing you to flexibly multi-select the **Tools** and **Rules** you want to install, and will automatically handle all environment configurations for you.*
52
61
 
53
62
  ---
54
63
 
55
64
  ## 📚 Commands
56
65
 
57
- ### 1. Add Resources (`add` / `a`)
58
-
59
- ```bash
60
- vibe add <repository>
61
-
62
- ```
63
-
64
- **Execution Flow**:
65
-
66
- 1. Invokes native capabilities to install basic Agent skills from the target repository.
67
- 2. Clones and parses the `skill`, `tool`, and `rules` asset directories in the target repository.
68
- 3. Triggers an interactive multi-select list to pick specific tool scripts and rule documents on demand.
69
- 4. Automatically executes file copying, intelligently merges common rules, updates `opencode.jsonc`, and configures the Python dependency environment (if needed).
70
-
71
- ### 2. List Installed Items (`list` / `ls`)
72
-
73
- ```bash
74
- vibe list
75
-
76
- ```
77
-
78
- **Function**:
79
- Clearly prints a status map of all installed resources in the current project, including:
80
-
81
- * 🛠️ Local Tools
82
- * 📜 Injected Context Rules (Local Rules)
83
- * 🪄 Global Standard Skills
66
+ | Command | Alias | Description |
67
+ | --- | --- | --- |
68
+ | `vibe add <repo>` | `a` | Parses the target GitHub repo, launches a UI list for on-demand installation of tools/rules, and auto-injects configurations. |
69
+ | `vibe list` | `ls` | Prints a clear status map of all installed resources (local tools, context rules, global standard skills) in the current project. |
70
+ | `vibe update` | `up` | Concurrently pulls all source repositories listed in `vibe-lock.json` with one click, intelligently comparing and overwriting local scripts and rules. |
71
+ | `vibe remove [resource]` | `rm` | **Run without args**: Launches a UI multi-select list to delete local items.<br>
84
72
 
85
- ### 3. One-Click Sync & Update (`update` / `up`)
73
+ <br>
86
74
 
87
- ```bash
88
- vibe update
75
+ <br>**Run with args**: Quickly matches and removes specified standard skills or local tools, synchronously cleaning up configurations. |
76
+ ---
89
77
 
90
- ```
78
+ ## 🏗️ Build Your Own Resource Repository
91
79
 
92
- **Function**:
93
- Executes a full workspace update with one click. The CLI will concurrently pull all source repositories recorded in `vibe-lock.json`, intelligently compare and overwrite the latest local scripts and rule files, and simultaneously trigger an upgrade of the standard skills library.
80
+ We strongly encourage you or your team to create dedicated Vibe Coding resource repositories on GitHub to standardize your team's favorite AI tools and custom coding conventions across all projects.
94
81
 
95
- ### 4. Remove Resources (`remove` / `rm`)
82
+ ### Recommended Directory Structure
96
83
 
97
- ```bash
98
- # Interactive mode: Pops up a UI list to select tools and rules to remove
99
- vibe remove
84
+ To ensure perfect compatibility with `@vibe-coder/cli`, we recommend adopting the following conventions (refer to `helloggx/skill`):
100
85
 
101
- # Shortcut mode: Directly specify the resource to remove (supports standard skills and local tools/rules)
102
- vibe remove <resource>
86
+ ```text
87
+ your-custom-repo/
88
+ ├── skill/ # (Optional) Standard Vercel AI Agent skill library
89
+ ├── tool/ # Custom TS/Python executable tools
90
+ │ ├── get_dsl.ts
91
+ │ ├── get_dsl.py # 💡 Python scripts should share the same name as the TS tool calling them
92
+ │ └── shadcn_vue_init.ts
93
+ └── rules/ # Personalized Markdown context rules
94
+ ├── common/ # Global common rules applicable to all projects
95
+ │ ├── coding-style.md
96
+ │ └── security.md
97
+ └── typescript/ # Tech-stack specific rules
98
+ └── coding-style.md # 💡 Recommended to share the same name as the extended common rule
103
99
 
104
100
  ```
105
101
 
106
- **Execution Flow**:
102
+ ### Organization Best Practices
107
103
 
108
- 1. Invokes native capabilities to remove standard Agent skills from the target repository (via `pnpx skills remove`).
109
- 2. Parses the list of installed resources in the local `vibe-lock.json`.
110
- 3. **Interactive Mode**: Pops up a multi-select list, allowing you to choose specific tools and rule categories for removal.
111
- 4. **Shortcut Mode**: Directly matches and removes local tool/rule files based on the passed arguments.
112
- 5. Automatically cleans up the corresponding physical files (`.opencode/tool/` and `.opencode/rules/`) and synchronously updates the `opencode.jsonc` configuration.
104
+ * **Cross-language tool linkage**: If your `.ts` tool relies on an underlying `.py` script, **ensure the base names of both files are exactly the same** (e.g., `get_dsl.ts` and `get_dsl.py`). The CLI will intelligently recognize and pull them together.
105
+ * **Rule inheritance and extension**:
106
+ * Global common rules must be placed under `rules/common/`.
107
+ * When writing rules for a specific tech stack (e.g., `rules/typescript/`), if you need to inherit a `common` rule, it is recommended to **keep the same name** and explicitly declare the inheritance at the top of the file:
108
+ *> This file extends [common/coding-style.md](https://www.google.com/search?q=../common/coding-style.md) and adds TS-specific content.*
113
109
 
114
110
  ---
115
111
 
116
112
  ## 📂 Workspace Structure
117
113
 
118
- After running `vibe add`, the tool will automatically create and maintain the following standard Vibe Coding structure in your project's root directory:
114
+ After running `vibe add`, the tool will automatically take over and maintain the following structure in your project's root directory:
119
115
 
120
116
  ```text
121
117
  your-project/
122
118
  ├── .opencode/
123
-   ├── tool/                   # Stores the pulled underlying .ts / .py tool scripts
124
-   │   ├── get_dsl.ts
125
-   │   └── ...
126
-   ├── rules/                  # Stores the pulled .md rule files (categorized by type)
127
- │   │   ├── common/
128
- │   │   └── typescript/
129
- │   ├── opencode.jsonc          # Core OpenCode configuration file
130
- │   │                           # (vibe automatically manages "tools": {...} and "instructions": [...] inside)
131
- │   └── vibe-lock.json          # Internal state lock file, accurately recording resource sources, versions, and update timestamps
132
- ├── .venv/                      # (Auto-created as needed) Isolated Python virtual environment
133
- └── requirements.txt            # (Auto-maintained as needed) Dependency list required for Python scripts
119
+ ├── tool/ # Underlying .ts / .py tool scripts
120
+ ├── rules/ # .md rule files (archived by category)
121
+ ├── opencode.jsonc # Core OpenCode configuration (CLI auto-injects tool toggles & directive paths)
122
+ └── vibe-lock.json # State lock file, accurately recording resource origins and versions
123
+ ├── .venv/ # (Created on demand) Isolated Python virtual environment
124
+ └── requirements.txt # (Maintained on demand) Python script dependency list
134
125
 
135
126
  ```
136
127
 
137
128
  ---
138
129
 
139
- ## 🛠️ Development
130
+ ## 🤝 Join the Ecosystem
140
131
 
141
- This project is built on top of [Bun](https://bun.sh/), offering a lightning-fast execution and bundling experience.
132
+ If your open-source project (like Agent Skills, Tools, or Rules) is compatible with and utilizes the vibe-coding specification, you are welcome to add this exclusive badge to your `README.md` to show off your modern workflow to the community!
142
133
 
143
- ```bash
144
- # 1. Install project dependencies
145
- bun install
134
+ Copy the following Markdown code to add it to your project:
146
135
 
147
- # 2. Run CLI locally for debugging
148
- bun run dev --help
136
+ ```markdown
137
+ [![vibe-coding: enabled](https://img.shields.io/badge/vibe--coding-enabled-BD00FF?style=flat-square&logo=github&logoColor=white&labelColor=2D3748)](https://github.com/HelloGGX/vibe-coding-cli)
138
+ ```
149
139
 
150
- # 3. Strict type checking
151
- bun run typecheck
140
+ *(By adding the badge, you'll have the opportunity to be featured in the official Hall of Fame curated list!)*
152
141
 
153
- # 4. Build production version (outputs to ./dist)
154
- bun run build
142
+ ## 🛠️ Development
143
+
144
+ This project is built on top of the blazing-fast [Bun](https://bun.sh/) runtime.
155
145
 
146
+ ```bash
147
+ bun install # 1. Install dependencies
148
+ bun run dev --help # 2. Local debugging
149
+ bun run typecheck # 3. Type checking
150
+ bun run build # 4. Build production version (outputs to ./dist)
156
151
  ```
157
152
 
158
153
  ## 📄 License
159
154
 
160
- This project is open-sourced under the [MIT License](https://www.google.com/search?q=../../LICENSE.md).
161
- © 2026 [HelloGGX](https://github.com/HelloGGX)
155
+ [MIT License](https://www.google.com/search?q=../../LICENSE.md) © 2026 [HelloGGX](https://github.com/HelloGGX)
package/README.zh.md CHANGED
@@ -4,42 +4,48 @@
4
4
 
5
5
  **专为 OpenCode 打造的 vibe coding 生态构建工具**
6
6
 
7
- [![Version](https://img.shields.io/badge/version-1.0.1-blue.svg)](./package.json)
8
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](../../LICENSE.md)
9
- [![Built with Bun](https://img.shields.io/badge/Bun-%23000000.svg?logo=bun&logoColor=white)](https://bun.sh)
7
+ [![vibe-coding: enabled](https://img.shields.io/badge/vibe--coding-enabled-BD00FF?style=flat-square&logo=github&logoColor=white&labelColor=2D3748)](https://github.com/HelloGGX/vibe-coding-cli)
8
+ [![npm version](https://img.shields.io/npm/v/@vibe-coder/cli.svg?style=flat-square)](https://www.npmjs.com/package/@vibe-coder/cli)
9
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](../../LICENSE.md)
10
+ [![Built with Bun](https://img.shields.io/badge/Bun-%23000000.svg?style=flat-square&logo=bun&logoColor=white)](https://bun.sh)
10
11
 
11
12
  [English](https://github.com/HelloGGX/skill/blob/main/packages/vibe/README.md) · **简体中文**
12
13
 
14
+ > *一键聚合 AI 工具与上下文规范,让 Agent 真正懂你的代码架构。*
15
+
13
16
  </div>
14
17
 
15
18
  ## 📖 简介 (Introduction)
16
19
 
17
- `vibe-coding-cli` 是一个专为 **OpenCode** 平台打造的现代命令行脚手架工具。它的核心目标是快速搭建 Vibe Coding 的开发环境,简化规范驱动开发的资源管理。
20
+ `@vibe-coder/cli` 是一个专为 **OpenCode** 平台打造的现代命令行脚手架工具。它的核心目标是快速搭建 Vibe Coding 的开发环境,简化规范驱动开发的资源管理。
18
21
 
19
- 通过 `vibe` 命令,你可以一键拉取远程 GitHub 仓库中的 TypeScript/Python 工具脚本或 Markdown 规则文件,自动将其无缝注册到 OpenCode 配置中,并接管其底层的运行依赖环境,让你专注于“与 AI 共创代码”本身。
22
+ 通过 `vibe` 命令,你可以一键拉取远程 GitHub 仓库中的 TypeScript/Python 工具脚本或 Markdown 规则文件,自动无缝注册到 OpenCode 配置中,并接管底层运行依赖,让你专注于**“与 AI 共创代码”**本身。
20
23
 
21
24
  ## ✨ 核心特性 (Features)
22
25
 
23
- - 🛠 **全自动化工具管理**: 支持从任意 GitHub 仓库快速解析、选择并下载 `.ts` / `.py` 脚本至本地 `.opencode/tool/` 目录,开箱即用。
24
- - 📜 **集成 Vibe Coding 所需的一切**: 独创的生态聚合能力,将 Agent 执行所需的 **Capabilities(工具与技能)** 与 **Context(行为准则与最佳实践)** 完美融合。支持按需安装 `.md` 规则文件,让 AI 真正懂你的架构意图与代码规范。
25
- - 📦 **智能配置注入**: 自动拦截并更新 `.opencode/opencode.jsonc`,无感注入工具的启用开关与 Prompt 指令(instructions)路径,彻底告别繁琐的手动配置。
26
- - ⚡ **并行极速更新**: 基于并发模型设计,同时处理多个源仓库的资源对比与拉取,大幅缩短多依赖场景下的更新等待时间。
27
- - 🪄 **标准技能聚合**: 与 Vercel 的 `pnpx skills` 生态深度集成,在统一的 CLI 流程中同时管理标准 Agent 技能库和本地化扩展资源。
26
+ - 🛠 **全自动化工具管理**: 支持从任意 GitHub 仓库快速解析、多选并下载 `.ts` / `.py` 脚本至本地开箱即用。
27
+ - 📜 **Context Capabilities 完美融合**: 独创生态聚合能力,将 Agent 执行所需的**工具技能**与**行为准则**深度绑定。支持按需安装 `.md` 规则文件,让 AI 真正懂你的架构意图。
28
+ - 📦 **智能配置注入**: 自动拦截并更新 `.opencode/opencode.jsonc`,无感注入工具开关与 Prompt 指令路径,告别繁琐的手动配置。
29
+ - ⚡ **并行极速更新**: 基于并发模型设计,同时处理多个源仓库的资源对比与拉取,大幅缩短更新等待时间。
30
+ - 🪄 **标准技能聚合**: 与 Vercel 的 `pnpx skills` 生态深度集成,在统一的 CLI 流程中同时管理标准 Agent 技能库和本地扩展资源。
28
31
 
29
32
  ---
30
33
 
31
34
  ## 🚀 快速开始 (Quick Start)
32
35
 
36
+ ### 环境要求 (Prerequisites)
37
+ - [Node.js](https://nodejs.org/) >= 18.0.0 或 [Bun](https://bun.sh/) >= 1.0.0
38
+
33
39
  ### 安装
34
40
 
35
- 作为全局包安装(推荐使用 npm 或 bun):
41
+ 作为全局包安装:
36
42
 
37
43
  ```bash
38
44
  # 使用 npm
39
- npm install -g vibe-coding-cli
45
+ npm i -g @vibe-coder/cli
40
46
 
41
47
  # 使用 bun
42
- bun add -g vibe-coding-cli
48
+ bun add -g @vibe-coder/cli
43
49
  ```
44
50
 
45
51
  ### 基础用法
@@ -50,108 +56,99 @@ bun add -g vibe-coding-cli
50
56
  vibe add helloggx/skill
51
57
  ```
52
58
 
53
- *此命令将会弹出交互式菜单,允许你灵活多选想要安装的 **Tools (工具)** 和 **Rules (规则)**,CLI 将会自动为你完成所有环境的配置。*
59
+ *CLI 将唤起交互式菜单,允许你灵活多选想要安装的 **Tools (工具)** 和 **Rules (规则)**,并自动为你完成所有环境配置。*
54
60
 
55
61
  ---
56
62
 
57
63
  ## 📚 命令指南 (Commands)
58
64
 
59
- ### 1. 添加资源 (`add` / `a`)
60
-
61
- ```bash
62
- vibe add <repository>
63
- ```
64
-
65
- **执行流程**:
65
+ | 命令 | 别名 | 功能描述 |
66
+ | --- | --- | --- |
67
+ | `vibe add <repo>` | `a` | 解析目标 GitHub 仓库,唤起 UI 列表,按需安装工具和规则文件,并自动注入配置。 |
68
+ | `vibe list` | `ls` | 清晰打印当前项目中所有已安装资源(本地工具、上下文规则、全局标准技能)的态势图。 |
69
+ | `vibe update` | `up` | 一键并发拉取 `vibe-lock.json` 中的所有源仓库,智能比对并覆盖本地脚本与规则。 |
70
+ | `vibe remove [资源]` | `rm` | **无参运行**:唤起 UI 多选列表删除本地项。<br>
66
71
 
67
- 1. 调用原生能力,安装目标仓库中的基础 Agent 技能。
68
- 2. 克隆并解析目标仓库中的 `skill`、`tool` 和 `rules` 资产目录。
69
- 3. 唤起交互式多选列表,按需挑选具体的工具脚本和规则文档。
70
- 4. 自动执行文件拷贝、智能合并公共规则、更新 `opencode.jsonc` 并配置 Python 依赖环境(如需)。
72
+ <br>**带参运行**:快捷匹配并移除指定的标准技能或本地工具,并同步清理配置。 |
71
73
 
72
- ### 2. 查看已安装项 (`list` / `ls`)
74
+ ---
73
75
 
74
- ```bash
75
- vibe list
76
- ```
76
+ ## 🏗️ 构建你自己的资源仓库
77
77
 
78
- **功能**:
79
- 清晰打印当前项目中安装的所有资源态势图,包含:
78
+ 我们强烈鼓励你或团队在 GitHub 上创建专属的 Vibe Coding 资源仓库,以在所有项目中标准化团队最喜欢的 AI 工具和自定义编码规范。
80
79
 
81
- * 🛠️ 本地扩展工具 (Local Tools)
82
- * 📜 注入的上下文规则 (Local Rules)
83
- * 🪄 全局标准技能 (Standard Skills)
80
+ ### 推荐目录结构
84
81
 
85
- ### 3. 一键同步更新 (`update` / `up`)
82
+ 为确保与 `@vibe-coder/cli` 完美兼容,推荐采用以下约定(可参考 `helloggx/skill`):
86
83
 
87
- ```bash
88
- vibe update
84
+ ```text
85
+ your-custom-repo/
86
+ ├── skill/ # (可选) 标准的 Vercel AI Agent 技能库
87
+ ├── tool/ # 自定义 TS/Python 可执行工具
88
+ │ ├── get_dsl.ts
89
+ │ ├── get_dsl.py # 💡 Python 脚本应与其调用的 TS 工具同名
90
+ │ └── shadcn_vue_init.ts
91
+ └── rules/ # 个性化 Markdown 上下文规则
92
+ ├── common/ # 适用于所有项目的全局通用规则
93
+ │ ├── coding-style.md
94
+ │ └── security.md
95
+ └── typescript/ # 特定技术栈规则
96
+ └── coding-style.md # 💡 建议与被扩展的通用规则同名
89
97
  ```
90
98
 
91
- **功能**:
92
- 一键执行工作区全量更新。CLI 会并发拉取 `vibe-lock.json` 中记录的所有源仓库,智能比对并覆盖最新的本地脚本和规则文件,同时触发标准技能库的升级。
99
+ ### 组织最佳实践
93
100
 
94
- ### 4. 移除资源 (`remove` / `rm`)
101
+ * **跨语言工具联动**:若你的 `.ts` 工具依赖底层的 `.py` 脚本,**请确保两文件基础名称完全一致**(如 `get_dsl.ts` `get_dsl.py`)。CLI 会智能识别并一并拉取。
102
+ * **规则继承与扩展**:
103
+ * 全局通用规则务必放在 `rules/common/` 下。
104
+ * 为特定技术栈编写规则时(如 `rules/typescript/`),若需继承 `common` 规则,建议**保持同名**,并在文件顶部显式声明继承关系:
105
+ *> 此文件扩展了 [common/coding-style.md](https://www.google.com/search?q=../common/coding-style.md) 并增加了 TS 特定内容。*
95
106
 
96
- ```bash
97
- # 交互式模式:弹出 UI 列表选择要移除的工具和规则
98
- vibe remove
99
107
 
100
- # 快捷模式:直接指定要移除的资源(支持标准 skills 和本地工具/规则)
101
- vibe remove <resource>
102
- ```
103
-
104
- **执行流程**:
105
-
106
- 1. 调用原生能力,移除目标仓库中的标准 Agent 技能(通过 `pnpx skills remove`)。
107
- 2. 解析本地 `vibe-lock.json` 中的已安装资源列表。
108
- 3. **交互模式**:弹出多选列表,允许你选择具体的工具和规则分类进行移除。
109
- 4. **快捷模式**:根据传入的参数直接匹配并移除本地工具/规则文件。
110
- 5. 自动清理对应的物理文件(`.opencode/tool/` 和 `.opencode/rules/`),并同步更新 `opencode.jsonc` 配置。
111
108
 
112
109
  ---
113
110
 
114
111
  ## 📂 目录与配置规范 (Workspace Structure)
115
112
 
116
- 运行 `vibe add` 后,工具将在你的项目根目录下自动创建并维护以下标准 Vibe Coding 结构:
113
+ 运行 `vibe add` 后,工具将在项目根目录自动接管并维护以下结构:
117
114
 
118
115
  ```text
119
116
  your-project/
120
117
  ├── .opencode/
121
- │ ├── tool/ # 存放被拉取下来的底层 .ts / .py 工具脚本
122
- ├── get_dsl.ts
123
- │ └── ...
124
- ├── rules/ # 存放被拉取下来的 .md 规则文件(按类别分类归档)
125
- │ │ ├── common/
126
- │ │ └── typescript/
127
- │ ├── opencode.jsonc # OpenCode 核心配置文件
128
- │ │ # (vibe 会自动管理其中的 "tools": {...} 和 "instructions": [...])
129
- │ └── vibe-lock.json # 内部状态锁文件,精准记录资源来源仓库、版本与更新时间戳
118
+ │ ├── tool/ # 底层 .ts / .py 工具脚本
119
+ │ ├── rules/ # .md 规则文件(按类别归档)
120
+ ├── opencode.jsonc # OpenCode 核心配置(CLI 自动注入工具开关与指令路径)
121
+ └── vibe-lock.json # 状态锁文件,精准记录资源来源与版本
130
122
  ├── .venv/ # (按需自动创建) 隔离的 Python 虚拟环境
131
- └── requirements.txt # (按需自动维护) Python 脚本所需的依赖清单
123
+ └── requirements.txt # (按需自动维护) Python 脚本依赖清单
132
124
  ```
133
125
 
134
126
  ---
135
127
 
136
- ## 🛠️ 开发者指南 (Development)
137
128
 
138
- 本项目底层基于 [Bun](https://bun.sh/) 构建,拥有极速的执行与打包体验。
129
+ ## 🤝 融入生态 (Join the Ecosystem)
139
130
 
140
- ```bash
141
- # 1. 安装项目依赖
142
- bun install
131
+ 如果你的开源项目(如 Agent Skills、Tools 或 Rules)兼容并使用了 vibe-coding 规范,欢迎在你的 `README.md` 中挂上这枚专属徽章,向社区展示你的前卫品味!
143
132
 
144
- # 2. 本地调试运行 CLI
145
- bun run dev --help
133
+ 复制以下 Markdown 代码即可添加到你的项目中:
146
134
 
147
- # 3. 严格类型检查
148
- bun run typecheck
135
+ ```markdown
136
+ [![vibe-coding: enabled](https://img.shields.io/badge/vibe--coding-enabled-BD00FF?style=flat-square&logo=github&logoColor=white&labelColor=2D3748)](https://github.com/HelloGGX/vibe-coding-cli)
137
+ ```
138
+ (挂上徽章后,你将有机会被收录进官方的名人堂精选列表!)
149
139
 
150
- # 4. 构建生产版本 (输出至 ./dist)
151
- bun run build
140
+
141
+ ## 🛠️ 开发者指南 (Development)
142
+
143
+ 本项目基于极速的 [Bun](https://bun.sh/) 运行时构建。
144
+
145
+ ```bash
146
+ bun install # 1. 安装依赖
147
+ bun run dev --help # 2. 本地调试
148
+ bun run typecheck # 3. 类型检查
149
+ bun run build # 4. 构建生产版本 (输出至 ./dist)
152
150
  ```
153
151
 
154
152
  ## 📄 许可证 (License)
155
153
 
156
- 本项目采用 [MIT License](https://www.google.com/search?q=../../LICENSE.md) 进行开源。
157
- © 2026 [HelloGGX](https://github.com/HelloGGX)
154
+ [MIT License](https://www.google.com/search?q=../../LICENSE.md) © 2026 [HelloGGX](https://github.com/HelloGGX)
package/dist/cli.js CHANGED
@@ -6583,6 +6583,19 @@ async function runRemove(args) {
6583
6583
  }
6584
6584
 
6585
6585
  // src/cli.ts
6586
+ import { join as join2 } from "node:path";
6587
+ import { readFileSync as readFileSync3 } from "node:fs";
6588
+ var __dirname = "/Users/xiaoluo/Desktop/work/skill/packages/vibe/src";
6589
+ function getVersion() {
6590
+ try {
6591
+ const pkgPath = join2(__dirname, "..", "package.json");
6592
+ const pkg = JSON.parse(readFileSync3(pkgPath, "utf-8"));
6593
+ return pkg.version;
6594
+ } catch {
6595
+ return "0.0.0";
6596
+ }
6597
+ }
6598
+ var VERSION = getVersion();
6586
6599
  var VIBE_LOGO = [
6587
6600
  "██╗ ██╗██╗██████╗ ███████╗",
6588
6601
  "██║ ██║██║██╔══██╗██╔════╝",
@@ -6615,6 +6628,7 @@ function showBanner() {
6615
6628
  console.log(` ${DIM}$${RESET} ${TEXT}vibe list${RESET} ${DIM}List installed tools & skills${RESET}`);
6616
6629
  console.log(` ${DIM}$${RESET} ${TEXT}vibe update${RESET} ${DIM}Update installed tools & skills${RESET}`);
6617
6630
  console.log(` ${DIM}$${RESET} ${TEXT}vibe remove${RESET} ${DIM}Remove tools & rules${RESET}`);
6631
+ console.log(` ${DIM}$${RESET} ${TEXT}vibe version${RESET} ${DIM}Show version${RESET}`);
6618
6632
  console.log();
6619
6633
  console.log(`${DIM}Example:${RESET} vibe add helloggx/skill`);
6620
6634
  console.log();
@@ -6633,6 +6647,7 @@ ${BOLD}Manage Tools & Skills:${RESET}
6633
6647
 
6634
6648
  ${BOLD}Options:${RESET}
6635
6649
  --help, -h Show this help message
6650
+ --version, -v Show version number
6636
6651
 
6637
6652
  ${BOLD}Examples:${RESET}
6638
6653
  ${DIM}$${RESET} vibe add helloggx/skill
@@ -6670,11 +6685,14 @@ async function main() {
6670
6685
  case "update":
6671
6686
  await runUpdate(args.slice(1));
6672
6687
  break;
6673
- case "--help":
6674
- case "-h":
6688
+ case "h":
6675
6689
  case "help":
6676
6690
  showHelp();
6677
6691
  break;
6692
+ case "v":
6693
+ case "version":
6694
+ console.log(VERSION);
6695
+ break;
6678
6696
  default:
6679
6697
  console.log(`${CYAN}vibe:${RESET} Unknown command '${command}'`);
6680
6698
  console.log(`Run ${BOLD}vibe --help${RESET} for usage.`);
package/package.json CHANGED
@@ -1,9 +1,15 @@
1
1
  {
2
2
  "name": "@vibe-coder/cli",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "Vibe Coding development tool",
5
5
  "private": false,
6
6
  "type": "module",
7
+ "author": "HelloGGX",
8
+ "license": "MIT",
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "https://github.com/HelloGGX/skill.git"
12
+ },
7
13
  "bin": {
8
14
  "vibe": "./bin/vibe"
9
15
  },
@@ -22,7 +28,8 @@
22
28
  "keywords": [
23
29
  "cli",
24
30
  "agent-skills",
25
- "skills"
31
+ "skills",
32
+ "vibe-coding"
26
33
  ],
27
34
  "dependencies": {
28
35
  "@clack/prompts": "^1.0.1",
@@ -33,5 +40,9 @@
33
40
  "@types/bun": "1.3.9",
34
41
  "@types/node": "22.13.9",
35
42
  "typescript": "5.8.2"
36
- }
43
+ },
44
+ "bugs": {
45
+ "url": "https://github.com/HelloGGX/skill/issues"
46
+ },
47
+ "homepage": "https://github.com/HelloGGX/skill#readme"
37
48
  }