mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 15:13:28 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
f4cd4a0d82 | ||
|
|
cda05058ea | ||
|
|
bf512d9b02 | ||
|
|
7d2fddd34c | ||
|
|
552afdf258 | ||
|
|
77f131bd9c | ||
|
|
ff498bd224 | ||
|
|
85db58afe5 | ||
|
|
fe4e42457e | ||
|
|
5a2392cf40 | ||
|
|
bb2614dc13 | ||
|
|
ee376c6926 | ||
|
|
6e8e5af539 | ||
|
|
f642cb0e31 | ||
|
|
ba8fa7484b |
@@ -5,184 +5,170 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This skill introduces the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. It covers how to add new skills or agents, update commands, manage install targets, maintain tests, update documentation, automate hooks, and handle dependency updates. Following these patterns ensures consistency, maintainability, and ease of collaboration across the codebase.
|
||||
|
||||
---
|
||||
This skill introduces the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` repository. The project is a JavaScript codebase (no framework detected) focused on modular skills, agent orchestration, automation workflows, and extensible install targets. It emphasizes clear documentation, conventional commits, and a structured approach to adding new capabilities.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and folders.
|
||||
- Example: `installManifests.js`, `voiceProfileSchema.md`
|
||||
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const installManifests = require('./installManifests');
|
||||
```
|
||||
|
||||
**Export Style**
|
||||
- Mixed: Both CommonJS (`module.exports`) and ES6 (`export`) styles are present.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
```
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function doSomething() { ... }
|
||||
```
|
||||
|
||||
**Commit Messages**
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/).
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example:
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
_Example:_
|
||||
```
|
||||
feat: add voice profile schema reference for new agent
|
||||
installTargetProject.js
|
||||
agentPipeline.md
|
||||
```
|
||||
|
||||
---
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules within the codebase.
|
||||
_Example:_
|
||||
```js
|
||||
const installTarget = require('../lib/install-targets/codeBuddy-project.js');
|
||||
```
|
||||
|
||||
- **Export Style:**
|
||||
Mixed usage of CommonJS (`module.exports`) and ES module (`export`) patterns, depending on context.
|
||||
_Example (CommonJS):_
|
||||
```js
|
||||
module.exports = function installTarget() { ... };
|
||||
```
|
||||
_Example (ESM):_
|
||||
```js
|
||||
export function installTarget() { ... }
|
||||
```
|
||||
|
||||
- **Commit Messages:**
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/) with prefixes: `fix`, `feat`, `docs`, `chore`.
|
||||
_Example:_
|
||||
```
|
||||
feat: add support for new agent pipeline
|
||||
fix: correct install script path resolution
|
||||
```
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill or Agent
|
||||
**Trigger:** When introducing a new skill or agent to the system
|
||||
### Add New Skill
|
||||
**Trigger:** When you want to add a new skill (capability, agent, or workflow)
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create or update `SKILL.md` in `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Add or update documentation files (`README.md`, `AGENTS.md`, `docs/zh-CN/AGENTS.md`, etc.).
|
||||
3. Register the new skill/agent in `manifests/install-components.json` or `manifests/install-modules.json`.
|
||||
4. Optionally, add reference files or assets (e.g., `references/voice-profile-schema.md`, `assets/`).
|
||||
5. If adding an agent, create `agents/<agent-name>.md`.
|
||||
1. Create a new `SKILL.md` file under `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Optionally add related reference files (schemas, assets) in the skill directory.
|
||||
3. Update documentation files to reference the new skill:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
4. Optionally update install manifests (e.g., `manifests/install-components.json`) if the skill is installable.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new skill called "voiceProfile"
|
||||
mkdir -p skills/voiceProfile
|
||||
touch skills/voiceProfile/SKILL.md
|
||||
# Edit manifests/install-components.json to register
|
||||
_Example directory structure:_
|
||||
```
|
||||
skills/myNewSkill/SKILL.md
|
||||
skills/myNewSkill/schema.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When adding or improving a CLI command
|
||||
### Add New Command or Workflow
|
||||
**Trigger:** When introducing a new command-line workflow or process
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update `commands/<command-name>.md` with YAML frontmatter, usage, and implementation details.
|
||||
2. Update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. Update or add corresponding skill or agent documentation if relevant.
|
||||
1. Create a new markdown file under `commands/` (e.g., `commands/myWorkflow.md`).
|
||||
2. Document the workflow with YAML frontmatter, usage, and output sections.
|
||||
3. Update `AGENTS.md`, `README.md`, or other summary files to reference the new command.
|
||||
4. Optionally update scripts or examples if automation is included.
|
||||
|
||||
**Example:**
|
||||
_Example:_
|
||||
```markdown
|
||||
# commands/review.md
|
||||
|
||||
---
|
||||
name: review
|
||||
description: Run code review workflow
|
||||
name: santa-loop
|
||||
description: Automates the Santa workflow
|
||||
---
|
||||
|
||||
## Usage
|
||||
...
|
||||
# santa-loop
|
||||
Usage: ...
|
||||
```
|
||||
|
||||
---
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent pipeline
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new IDE, tool, or platform for installation
|
||||
1. Create agent definition markdown files under `agents/` (e.g., `agents/myAgent.md`).
|
||||
2. Optionally, create a new orchestrator skill under `skills/<pipeline>/SKILL.md`.
|
||||
3. Update `AGENTS.md` and `README.md` to reference the new agent(s) or pipeline.
|
||||
4. Optionally add example or configuration files.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
agents/opensource-pipeline.md
|
||||
skills/opensource-pipeline/SKILL.md
|
||||
```
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new install target (IDE, platform) or updating install logic
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create install scripts and documentation in a new folder (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add or update install-manifests and registry scripts (`scripts/lib/install-manifests.js`, `scripts/lib/install-targets/*.js`).
|
||||
3. Update schemas (`schemas/ecc-install-config.schema.json`, `schemas/install-modules.schema.json`).
|
||||
4. Register the new target in `manifests/install-modules.json`.
|
||||
5. Add or update tests for install targets.
|
||||
1. Add or update install scripts and documentation under `.<target>/`.
|
||||
2. Update `manifests/install-modules.json` and related schemas.
|
||||
3. Add or update scripts in `scripts/lib/install-targets/<target>-project.js`.
|
||||
4. Update registry and test files as needed.
|
||||
5. Update `README.md` or other summary docs.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// scripts/lib/install-targets/codebuddy.js
|
||||
module.exports = function installCodebuddy() { ... };
|
||||
_Example:_
|
||||
```
|
||||
.codeBuddy/install.sh
|
||||
scripts/lib/install-targets/codeBuddy-project.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update or Fix Tests
|
||||
**Trigger:** When fixing or updating tests for compatibility or new features
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit test files in `tests/scripts/` or `tests/lib/` to address issues (e.g., path normalization, environment variables).
|
||||
2. Update implementation files if needed to support the test fix.
|
||||
3. Document the fix in the commit message.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// tests/lib/install-targets.test.js
|
||||
test('should normalize Windows paths', () => {
|
||||
...
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When improving or updating documentation for users or contributors
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add files like `README.md`, `WORKING-CONTEXT.md`, `AGENTS.md`, `the-shortform-guide.md`, and `docs/zh-CN/*`.
|
||||
2. Synchronize documentation across English and Chinese versions.
|
||||
3. Update or add troubleshooting guides and best practices.
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Automation Scripts
|
||||
**Trigger:** When improving repo hooks or automation scripts
|
||||
**Command:** `/update-hook`
|
||||
### Update or Add Hooks and Automation
|
||||
**Trigger:** When modifying or extending hooks and automation scripts
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
1. Edit `hooks/hooks.json` to add or update hook definitions.
|
||||
2. Update or add scripts in `scripts/hooks/` or `scripts/lib/`.
|
||||
3. Update or add tests for hooks in `tests/hooks/`.
|
||||
4. Document changes in commit messages.
|
||||
2. Modify or create scripts in `scripts/hooks/*.js` for hook logic.
|
||||
3. Update or add related test files under `tests/hooks/`.
|
||||
4. Optionally update `.cursor/hooks/` or other adapter-specific files.
|
||||
|
||||
---
|
||||
_Example:_
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": "node scripts/hooks/format.js"
|
||||
}
|
||||
```
|
||||
|
||||
### Dependency Update via Dependabot
|
||||
**Trigger:** When dependencies are bumped by dependabot or maintainers
|
||||
**Command:** `/bump-dep`
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When updating documentation or adding new guidance
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Update dependency version in `package.json` or workflow YAML.
|
||||
2. Update lockfile (`yarn.lock` or `package-lock.json`).
|
||||
3. Commit with standardized message (`chore(deps): ...`).
|
||||
4. Update related workflow files if needed (`.github/workflows/*.yml`).
|
||||
1. Edit or create markdown files in the repo root or `docs/` directories.
|
||||
2. Update `WORKING-CONTEXT.md` to reflect current practices.
|
||||
3. Update or add `README.md`, `README.zh-CN.md`, and `AGENTS.md`.
|
||||
4. Optionally update `.claude-plugin/` or `.codex-plugin/` README files.
|
||||
|
||||
---
|
||||
### Test or CI Fix
|
||||
**Trigger:** When fixing or improving tests and CI integration
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit test files under `tests/`.
|
||||
2. Optionally edit scripts or hooks related to the test.
|
||||
3. Update CI workflow files under `.github/workflows/` if needed.
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- Test files use the pattern `*.test.js` and are located in `tests/scripts/` and `tests/lib/`.
|
||||
- Testing framework is not explicitly specified; use standard Node.js test runners (e.g., Jest, Mocha).
|
||||
- Tests focus on platform compatibility, feature coverage, and regression prevention.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// tests/scripts/installScript.test.js
|
||||
describe('installScript', () => {
|
||||
it('should handle environment variables', () => {
|
||||
...
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
- **Test Framework:** Not explicitly specified; test files follow the `*.test.js` pattern.
|
||||
- **Test File Location:** Place test files under `tests/`, mirroring the structure of the code they test.
|
||||
- **Example:**
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
tests/hooks/format.test.js
|
||||
```
|
||||
- **Running Tests:**
|
||||
Ensure your tests are named with `.test.js` and can be run via your preferred test runner (e.g., `node`, `jest`, etc.).
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|-----------------|----------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill or agent, including docs and registration |
|
||||
| /add-command | Add or update a CLI command and its documentation |
|
||||
| /add-install-target | Add a new install target or adapter for integration |
|
||||
| /fix-test | Fix or update test files for compatibility or new features |
|
||||
| /update-docs | Update documentation and guidance files |
|
||||
| /update-hook | Update hooks or automation scripts |
|
||||
| /bump-dep | Bump dependency versions via dependabot or manually |
|
||||
| Command | Purpose |
|
||||
|--------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill (capability, agent, or workflow) |
|
||||
| /add-command | Add a new command or workflow |
|
||||
| /add-agent-pipeline| Add a new agent or multi-agent pipeline |
|
||||
| /add-install-target| Add or update an install target (IDE, platform, plugin host) |
|
||||
| /update-hooks | Update or add hooks and automation scripts |
|
||||
| /update-docs | Update documentation and guidance |
|
||||
| /fix-test | Fix or improve tests and CI integration |
|
||||
```
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
name: add-new-skill-or-agent
|
||||
description: Workflow command scaffold for add-new-skill-or-agent in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-new-skill-or-agent
|
||||
|
||||
Use this workflow when working on **add-new-skill-or-agent** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill or agent to the codebase, including documentation and registration in manifests and index files.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create or update SKILL.md in skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
- Add or update documentation files (README.md, AGENTS.md, docs/zh-CN/AGENTS.md, etc.)
|
||||
- Update manifests/install-components.json or manifests/install-modules.json to register the new skill/agent
|
||||
- Optionally add reference files or assets (e.g., references/voice-profile-schema.md, assets/)
|
||||
- If agent, add agents/<agent-name>.md
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
41
.claude/commands/add-new-skill.md
Normal file
41
.claude/commands/add-new-skill.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
name: add-new-skill
|
||||
description: Workflow command scaffold for add-new-skill in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-new-skill
|
||||
|
||||
Use this workflow when working on **add-new-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill to the system, including documentation and references in summary/index files.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
|
||||
## Suggested Sequence
|
||||
|
||||
1. Understand the current state and failure mode before editing.
|
||||
2. Make the smallest coherent change that satisfies the workflow goal.
|
||||
3. Run the most relevant verification for touched files.
|
||||
4. Summarize what changed and what still needs review.
|
||||
|
||||
## Typical Commit Signals
|
||||
|
||||
- Create a new SKILL.md file under skills/<skill-name>/ or .agents/skills/<skill-name>/
|
||||
- Optionally add related reference files (e.g., schemas, assets) under the skill directory
|
||||
- Update AGENTS.md, README.md, README.zh-CN.md, and docs/zh-CN/AGENTS.md to reference the new skill
|
||||
- Optionally update manifests/install-*.json if the skill is installable
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
@@ -2,7 +2,7 @@
|
||||
"version": "1.3",
|
||||
"schemaVersion": "1.0",
|
||||
"generatedBy": "ecc-tools",
|
||||
"generatedAt": "2026-04-02T03:26:28.561Z",
|
||||
"generatedAt": "2026-04-02T03:26:25.798Z",
|
||||
"repo": "https://github.com/affaan-m/everything-claude-code",
|
||||
"profiles": {
|
||||
"requested": "full",
|
||||
@@ -150,7 +150,7 @@
|
||||
".claude/enterprise/controls.md",
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"packageFiles": {
|
||||
"runtime-core": [
|
||||
@@ -180,7 +180,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"moduleFiles": {
|
||||
@@ -211,7 +211,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"files": [
|
||||
@@ -297,8 +297,8 @@
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-new-skill-or-agent.md",
|
||||
"description": "Workflow command scaffold for add-new-skill-or-agent."
|
||||
"path": ".claude/commands/add-new-skill.md",
|
||||
"description": "Workflow command scaffold for add-new-skill."
|
||||
}
|
||||
],
|
||||
"workflows": [
|
||||
@@ -311,8 +311,8 @@
|
||||
"path": ".claude/commands/refactoring.md"
|
||||
},
|
||||
{
|
||||
"command": "add-new-skill-or-agent",
|
||||
"path": ".claude/commands/add-new-skill-or-agent.md"
|
||||
"command": "add-new-skill",
|
||||
"path": ".claude/commands/add-new-skill.md"
|
||||
}
|
||||
],
|
||||
"adapters": {
|
||||
@@ -322,7 +322,7 @@
|
||||
"commandPaths": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
]
|
||||
},
|
||||
"codex": {
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-02T03:27:09.077Z"
|
||||
"createdAt": "2026-04-02T03:27:07.927Z"
|
||||
}
|
||||
@@ -26,7 +26,7 @@ Generated by ECC Tools from repository history. Review before treating it as a h
|
||||
|
||||
- feature-development: Standard feature implementation workflow
|
||||
- refactoring: Code refactoring and cleanup workflow
|
||||
- add-new-skill-or-agent: Adds a new skill or agent to the codebase, including documentation and registration in manifests and index files.
|
||||
- add-new-skill: Adds a new skill to the system, including documentation and references in summary/index files.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -5,184 +5,170 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This skill introduces the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` JavaScript repository. It covers how to add new skills or agents, update commands, manage install targets, maintain tests, update documentation, automate hooks, and handle dependency updates. Following these patterns ensures consistency, maintainability, and ease of collaboration across the codebase.
|
||||
|
||||
---
|
||||
This skill introduces the core development patterns, coding conventions, and collaborative workflows used in the `everything-claude-code` repository. The project is a JavaScript codebase (no framework detected) focused on modular skills, agent orchestration, automation workflows, and extensible install targets. It emphasizes clear documentation, conventional commits, and a structured approach to adding new capabilities.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
**File Naming**
|
||||
- Use `camelCase` for JavaScript files and folders.
|
||||
- Example: `installManifests.js`, `voiceProfileSchema.md`
|
||||
|
||||
**Import Style**
|
||||
- Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const installManifests = require('./installManifests');
|
||||
```
|
||||
|
||||
**Export Style**
|
||||
- Mixed: Both CommonJS (`module.exports`) and ES6 (`export`) styles are present.
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function doSomething() { ... };
|
||||
```
|
||||
- Example (ES6):
|
||||
```js
|
||||
export function doSomething() { ... }
|
||||
```
|
||||
|
||||
**Commit Messages**
|
||||
- Use [Conventional Commits](https://www.conventionalcommits.org/).
|
||||
- Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
- Example:
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
_Example:_
|
||||
```
|
||||
feat: add voice profile schema reference for new agent
|
||||
installTargetProject.js
|
||||
agentPipeline.md
|
||||
```
|
||||
|
||||
---
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules within the codebase.
|
||||
_Example:_
|
||||
```js
|
||||
const installTarget = require('../lib/install-targets/codeBuddy-project.js');
|
||||
```
|
||||
|
||||
- **Export Style:**
|
||||
Mixed usage of CommonJS (`module.exports`) and ES module (`export`) patterns, depending on context.
|
||||
_Example (CommonJS):_
|
||||
```js
|
||||
module.exports = function installTarget() { ... };
|
||||
```
|
||||
_Example (ESM):_
|
||||
```js
|
||||
export function installTarget() { ... }
|
||||
```
|
||||
|
||||
- **Commit Messages:**
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/) with prefixes: `fix`, `feat`, `docs`, `chore`.
|
||||
_Example:_
|
||||
```
|
||||
feat: add support for new agent pipeline
|
||||
fix: correct install script path resolution
|
||||
```
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill or Agent
|
||||
**Trigger:** When introducing a new skill or agent to the system
|
||||
### Add New Skill
|
||||
**Trigger:** When you want to add a new skill (capability, agent, or workflow)
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create or update `SKILL.md` in `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Add or update documentation files (`README.md`, `AGENTS.md`, `docs/zh-CN/AGENTS.md`, etc.).
|
||||
3. Register the new skill/agent in `manifests/install-components.json` or `manifests/install-modules.json`.
|
||||
4. Optionally, add reference files or assets (e.g., `references/voice-profile-schema.md`, `assets/`).
|
||||
5. If adding an agent, create `agents/<agent-name>.md`.
|
||||
1. Create a new `SKILL.md` file under `skills/<skill-name>/` or `.agents/skills/<skill-name>/`.
|
||||
2. Optionally add related reference files (schemas, assets) in the skill directory.
|
||||
3. Update documentation files to reference the new skill:
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `README.zh-CN.md`
|
||||
- `docs/zh-CN/AGENTS.md`
|
||||
4. Optionally update install manifests (e.g., `manifests/install-components.json`) if the skill is installable.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Add a new skill called "voiceProfile"
|
||||
mkdir -p skills/voiceProfile
|
||||
touch skills/voiceProfile/SKILL.md
|
||||
# Edit manifests/install-components.json to register
|
||||
_Example directory structure:_
|
||||
```
|
||||
skills/myNewSkill/SKILL.md
|
||||
skills/myNewSkill/schema.json
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When adding or improving a CLI command
|
||||
### Add New Command or Workflow
|
||||
**Trigger:** When introducing a new command-line workflow or process
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update `commands/<command-name>.md` with YAML frontmatter, usage, and implementation details.
|
||||
2. Update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. Update or add corresponding skill or agent documentation if relevant.
|
||||
1. Create a new markdown file under `commands/` (e.g., `commands/myWorkflow.md`).
|
||||
2. Document the workflow with YAML frontmatter, usage, and output sections.
|
||||
3. Update `AGENTS.md`, `README.md`, or other summary files to reference the new command.
|
||||
4. Optionally update scripts or examples if automation is included.
|
||||
|
||||
**Example:**
|
||||
_Example:_
|
||||
```markdown
|
||||
# commands/review.md
|
||||
|
||||
---
|
||||
name: review
|
||||
description: Run code review workflow
|
||||
name: santa-loop
|
||||
description: Automates the Santa workflow
|
||||
---
|
||||
|
||||
## Usage
|
||||
...
|
||||
# santa-loop
|
||||
Usage: ...
|
||||
```
|
||||
|
||||
---
|
||||
### Add New Agent or Agent Pipeline
|
||||
**Trigger:** When adding a new agent or multi-agent pipeline
|
||||
**Command:** `/add-agent-pipeline`
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new IDE, tool, or platform for installation
|
||||
1. Create agent definition markdown files under `agents/` (e.g., `agents/myAgent.md`).
|
||||
2. Optionally, create a new orchestrator skill under `skills/<pipeline>/SKILL.md`.
|
||||
3. Update `AGENTS.md` and `README.md` to reference the new agent(s) or pipeline.
|
||||
4. Optionally add example or configuration files.
|
||||
|
||||
_Example:_
|
||||
```
|
||||
agents/opensource-pipeline.md
|
||||
skills/opensource-pipeline/SKILL.md
|
||||
```
|
||||
|
||||
### Add or Update Install Target
|
||||
**Trigger:** When supporting a new install target (IDE, platform) or updating install logic
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Create install scripts and documentation in a new folder (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Add or update install-manifests and registry scripts (`scripts/lib/install-manifests.js`, `scripts/lib/install-targets/*.js`).
|
||||
3. Update schemas (`schemas/ecc-install-config.schema.json`, `schemas/install-modules.schema.json`).
|
||||
4. Register the new target in `manifests/install-modules.json`.
|
||||
5. Add or update tests for install targets.
|
||||
1. Add or update install scripts and documentation under `.<target>/`.
|
||||
2. Update `manifests/install-modules.json` and related schemas.
|
||||
3. Add or update scripts in `scripts/lib/install-targets/<target>-project.js`.
|
||||
4. Update registry and test files as needed.
|
||||
5. Update `README.md` or other summary docs.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// scripts/lib/install-targets/codebuddy.js
|
||||
module.exports = function installCodebuddy() { ... };
|
||||
_Example:_
|
||||
```
|
||||
.codeBuddy/install.sh
|
||||
scripts/lib/install-targets/codeBuddy-project.js
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update or Fix Tests
|
||||
**Trigger:** When fixing or updating tests for compatibility or new features
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit test files in `tests/scripts/` or `tests/lib/` to address issues (e.g., path normalization, environment variables).
|
||||
2. Update implementation files if needed to support the test fix.
|
||||
3. Document the fix in the commit message.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// tests/lib/install-targets.test.js
|
||||
test('should normalize Windows paths', () => {
|
||||
...
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When improving or updating documentation for users or contributors
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add files like `README.md`, `WORKING-CONTEXT.md`, `AGENTS.md`, `the-shortform-guide.md`, and `docs/zh-CN/*`.
|
||||
2. Synchronize documentation across English and Chinese versions.
|
||||
3. Update or add troubleshooting guides and best practices.
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Automation Scripts
|
||||
**Trigger:** When improving repo hooks or automation scripts
|
||||
**Command:** `/update-hook`
|
||||
### Update or Add Hooks and Automation
|
||||
**Trigger:** When modifying or extending hooks and automation scripts
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
1. Edit `hooks/hooks.json` to add or update hook definitions.
|
||||
2. Update or add scripts in `scripts/hooks/` or `scripts/lib/`.
|
||||
3. Update or add tests for hooks in `tests/hooks/`.
|
||||
4. Document changes in commit messages.
|
||||
2. Modify or create scripts in `scripts/hooks/*.js` for hook logic.
|
||||
3. Update or add related test files under `tests/hooks/`.
|
||||
4. Optionally update `.cursor/hooks/` or other adapter-specific files.
|
||||
|
||||
---
|
||||
_Example:_
|
||||
```json
|
||||
// hooks/hooks.json
|
||||
{
|
||||
"pre-commit": "node scripts/hooks/format.js"
|
||||
}
|
||||
```
|
||||
|
||||
### Dependency Update via Dependabot
|
||||
**Trigger:** When dependencies are bumped by dependabot or maintainers
|
||||
**Command:** `/bump-dep`
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When updating documentation or adding new guidance
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Update dependency version in `package.json` or workflow YAML.
|
||||
2. Update lockfile (`yarn.lock` or `package-lock.json`).
|
||||
3. Commit with standardized message (`chore(deps): ...`).
|
||||
4. Update related workflow files if needed (`.github/workflows/*.yml`).
|
||||
1. Edit or create markdown files in the repo root or `docs/` directories.
|
||||
2. Update `WORKING-CONTEXT.md` to reflect current practices.
|
||||
3. Update or add `README.md`, `README.zh-CN.md`, and `AGENTS.md`.
|
||||
4. Optionally update `.claude-plugin/` or `.codex-plugin/` README files.
|
||||
|
||||
---
|
||||
### Test or CI Fix
|
||||
**Trigger:** When fixing or improving tests and CI integration
|
||||
**Command:** `/fix-test`
|
||||
|
||||
1. Edit test files under `tests/`.
|
||||
2. Optionally edit scripts or hooks related to the test.
|
||||
3. Update CI workflow files under `.github/workflows/` if needed.
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- Test files use the pattern `*.test.js` and are located in `tests/scripts/` and `tests/lib/`.
|
||||
- Testing framework is not explicitly specified; use standard Node.js test runners (e.g., Jest, Mocha).
|
||||
- Tests focus on platform compatibility, feature coverage, and regression prevention.
|
||||
|
||||
**Example:**
|
||||
```js
|
||||
// tests/scripts/installScript.test.js
|
||||
describe('installScript', () => {
|
||||
it('should handle environment variables', () => {
|
||||
...
|
||||
});
|
||||
});
|
||||
```
|
||||
|
||||
---
|
||||
- **Test Framework:** Not explicitly specified; test files follow the `*.test.js` pattern.
|
||||
- **Test File Location:** Place test files under `tests/`, mirroring the structure of the code they test.
|
||||
- **Example:**
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
tests/hooks/format.test.js
|
||||
```
|
||||
- **Running Tests:**
|
||||
Ensure your tests are named with `.test.js` and can be run via your preferred test runner (e.g., `node`, `jest`, etc.).
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|-----------------|----------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill or agent, including docs and registration |
|
||||
| /add-command | Add or update a CLI command and its documentation |
|
||||
| /add-install-target | Add a new install target or adapter for integration |
|
||||
| /fix-test | Fix or update test files for compatibility or new features |
|
||||
| /update-docs | Update documentation and guidance files |
|
||||
| /update-hook | Update hooks or automation scripts |
|
||||
| /bump-dep | Bump dependency versions via dependabot or manually |
|
||||
| Command | Purpose |
|
||||
|--------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill (capability, agent, or workflow) |
|
||||
| /add-command | Add a new command or workflow |
|
||||
| /add-agent-pipeline| Add a new agent or multi-agent pipeline |
|
||||
| /add-install-target| Add or update an install target (IDE, platform, plugin host) |
|
||||
| /update-hooks | Update or add hooks and automation scripts |
|
||||
| /update-docs | Update documentation and guidance |
|
||||
| /fix-test | Fix or improve tests and CI integration |
|
||||
```
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"commandFiles": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill-or-agent.md"
|
||||
".claude/commands/add-new-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-02T03:26:28.561Z"
|
||||
"updatedAt": "2026-04-02T03:26:25.798Z"
|
||||
}
|
||||
Reference in New Issue
Block a user