mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-04-02 07:03:28 +08:00
Compare commits
15 Commits
ecc-tools/
...
ecc-tools/
| Author | SHA1 | Date | |
|---|---|---|---|
|
a23988866c | ||
|
|
4abc4e8887 | ||
|
|
dc1c46d453 | ||
|
|
7b1bc6d407 | ||
|
|
c89b166538 | ||
|
|
67ea3c5437 | ||
|
|
efd4b37555 | ||
|
|
5fdc208620 | ||
|
|
02ce835abb | ||
|
|
e81df5da4c | ||
|
|
1833739141 | ||
|
|
102d3196c7 | ||
|
|
8bfd408622 | ||
|
|
d67e19e830 | ||
|
|
483aa8530f |
@@ -5,171 +5,162 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches the core development patterns, coding conventions, and common workflows used in the `everything-claude-code` repository. The codebase is primarily JavaScript, with no major framework, and is organized around modular skills, agent definitions, command workflows, and extensible install targets. The repository emphasizes clear documentation, conventional commits, and maintainable architecture for agent and workflow development.
|
||||
This skill introduces the core development patterns, coding conventions, and common workflows for contributing to the `everything-claude-code` repository. The project is JavaScript-based, with no framework dependencies, and emphasizes modularity, agentic skills, and workflow automation. This guide covers file organization, commit conventions, code style, workflow steps, and testing patterns to help you contribute effectively and consistently.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
*Example:*
|
||||
```
|
||||
scripts/lib/installTargets.js
|
||||
agentPrompts.md
|
||||
```
|
||||
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules.
|
||||
*Example:*
|
||||
```js
|
||||
const installTarget = require('../lib/installTargets');
|
||||
```
|
||||
|
||||
- **Export Style:**
|
||||
Both CommonJS (`module.exports`) and ES module (`export`) styles are present.
|
||||
*Example (CommonJS):*
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
*Example (ES Module):*
|
||||
```js
|
||||
export function mySkill() { ... }
|
||||
```
|
||||
|
||||
- **Commit Messages:**
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/).
|
||||
Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
*Example:*
|
||||
```
|
||||
feat: add Gemini install target support
|
||||
fix: correct agent prompt registration logic
|
||||
```
|
||||
|
||||
- **Documentation:**
|
||||
Each skill or agent should have a `SKILL.md` or `.md` documentation file explaining its purpose and usage.
|
||||
- **File Naming:** Use camelCase for JavaScript files and folders.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Import Style:** Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./utils/helper');
|
||||
```
|
||||
- **Export Style:** Mixed (both CommonJS and ES module styles may be present).
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
- Example (ESM):
|
||||
```js
|
||||
export default function mySkill() { ... }
|
||||
```
|
||||
- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes such as `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target`
|
||||
- **Test Files:** Use the pattern `*.test.js` for test files.
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill for agents or workflows
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When introducing or updating a workflow, agent, or capability
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create a new `SKILL.md` file under `skills/`, `.agents/skills/`, or `.claude/skills/`.
|
||||
2. Document the skill's purpose, usage, and configuration.
|
||||
3. Optionally update manifests or documentation if the skill is significant.
|
||||
1. Create or update a `SKILL.md` file in one of:
|
||||
- `skills/<skill-name>/SKILL.md`
|
||||
- `.agents/skills/<skill-name>/SKILL.md`
|
||||
- `.claude/skills/<skill-name>/SKILL.md`
|
||||
2. Optionally update `AGENTS.md`, `README.md`, or `manifests/install-modules.json` to reference the new skill.
|
||||
3. Document the skill's usage and integration points.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
skills/myNewSkill/SKILL.md
|
||||
**Example:**
|
||||
```bash
|
||||
/add-skill
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Agent or Agent Prompt
|
||||
**Trigger:** When introducing a new agent persona or capability
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create a new agent definition (e.g., `agents/myAgent.md` or `.opencode/prompts/agents/myAgent.txt`).
|
||||
2. Register the agent in the relevant configuration file (e.g., `.opencode/opencode.json`).
|
||||
3. Update `AGENTS.md` or related documentation.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
agents/supportAgent.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When introducing or improving a workflow command
|
||||
### Add or Update a Command
|
||||
**Trigger:** When adding a new CLI command, workflow, or extending command capabilities
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a command file under `commands/` (e.g., `commands/review.md`).
|
||||
2. Optionally update related documentation or scripts.
|
||||
3. Address review feedback and refine command logic.
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/<command>.md`).
|
||||
2. Optionally update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. If the command is part of a workflow, update or create associated artifacts or scripts.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-command
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new platform or integration
|
||||
### Add or Update an Agent
|
||||
**Trigger:** When introducing a new agent or updating agent logic
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create or update agent definition markdown in `agents/<agent-name>.md` or `.opencode/prompts/agents/<agent>.txt`.
|
||||
2. Register or update the agent in `opencode.json` or related config.
|
||||
3. Update `AGENTS.md` with new agent details.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-agent
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Install Target
|
||||
**Trigger:** When supporting a new platform/tool for installation/integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add new install scripts and documentation under a dot-directory (e.g., `.gemini/`, `.codebuddy/`).
|
||||
2. Update `manifests/install-modules.json` and relevant schema files.
|
||||
3. Implement or update `scripts/lib/install-targets/*.js` for the new target.
|
||||
4. Add or update tests for the install target.
|
||||
1. Create or update install scripts (`.sh`/`.js`) and documentation in a dot-directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
3. Update `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/<target>.js`.
|
||||
4. Add or update tests for install targets.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
.gemini/install.sh
|
||||
scripts/lib/install-targets/gemini.js
|
||||
tests/lib/install-targets.test.js
|
||||
**Example:**
|
||||
```bash
|
||||
/add-install-target
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Refactor or Collapse Commands to Skills
|
||||
**Trigger:** When modernizing command logic under the skills architecture
|
||||
**Command:** `/refactor-to-skill`
|
||||
|
||||
1. Update or remove `commands/*.md` files.
|
||||
2. Add or update `skills/*/SKILL.md` files.
|
||||
3. Update documentation (`README.md`, `AGENTS.md`, `WORKING-CONTEXT.md`, etc.).
|
||||
4. Update manifests if required.
|
||||
|
||||
---
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When clarifying, updating, or adding documentation
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or create documentation files (`README.md`, `WORKING-CONTEXT.md`, `docs/*.md`, etc.).
|
||||
2. Sync or update guidance in multiple language versions if needed.
|
||||
3. Optionally update related configuration or manifest files.
|
||||
|
||||
---
|
||||
|
||||
### CI/CD Workflow Update
|
||||
**Trigger:** When improving or fixing CI/CD processes
|
||||
### Add or Update CI Workflow
|
||||
**Trigger:** When updating CI workflows, adding new checks, or bumping dependencies
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit `.github/workflows/*.yml` files.
|
||||
2. Update lockfiles (`package-lock.json`, `yarn.lock`) or validation scripts.
|
||||
3. Update or add test files for CI/CD logic.
|
||||
1. Edit or add files in `.github/workflows/`.
|
||||
2. Update `package.json` or `yarn.lock` if dependency-related.
|
||||
3. Test CI to ensure the new workflow or dependency works as intended.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-ci
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Validation Scripts
|
||||
**Trigger:** When improving or fixing pre/post hooks, or validation logic for edits and CI
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
1. Edit `hooks/hooks.json` and supporting scripts in `scripts/hooks/`.
|
||||
2. Update or add tests in `tests/hooks/` or `tests/scripts/`.
|
||||
3. Optionally update related documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-hooks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Documentation
|
||||
**Trigger:** When documenting new workflows, updating guides, or adding troubleshooting info
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add markdown files in `docs/`, `WORKING-CONTEXT.md`, or `the-shortform-guide.md`.
|
||||
2. Update `README.md` and/or `README.zh-CN.md`.
|
||||
3. Optionally update related skill or agent docs.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-docs
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:**
|
||||
Test files follow the pattern `*.test.js`.
|
||||
- **Test Files:** Place tests in the same directory as the code or in a `tests/` directory, using the `*.test.js` naming convention.
|
||||
- **Framework:** No specific testing framework detected; use standard JavaScript test runners (e.g., Jest, Mocha) as appropriate.
|
||||
- **Example Test File:**
|
||||
```js
|
||||
// mySkill.test.js
|
||||
const mySkill = require('./mySkill');
|
||||
|
||||
- **Framework:**
|
||||
No specific testing framework detected; structure your tests in standard Node.js or your preferred test runner.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
- **Test Example:**
|
||||
```js
|
||||
// install-targets.test.js
|
||||
const installTarget = require('../../scripts/lib/install-targets/gemini');
|
||||
|
||||
test('should install Gemini target', () => {
|
||||
expect(installTarget()).toBe(true);
|
||||
});
|
||||
```
|
||||
test('should return expected result', () => {
|
||||
expect(mySkill('input')).toBe('expected output');
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|----------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill module and document it |
|
||||
| /add-agent | Add a new agent definition or prompt |
|
||||
| /add-command | Add or update a command workflow |
|
||||
| /add-install-target| Add a new install target or adapter |
|
||||
| /refactor-to-skill | Refactor commands into skill-based modules |
|
||||
| /update-docs | Update documentation or guidance files |
|
||||
| /update-ci | Update CI/CD workflows, lockfiles, or validation scripts |
|
||||
| Command | Purpose |
|
||||
|---------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill (workflow, agent, or capability) |
|
||||
| /add-command | Add or update a command file for new or extended workflows |
|
||||
| /add-agent | Add or update an agent definition |
|
||||
| /add-install-target | Add or update an install target for external integrations |
|
||||
| /update-ci | Add or update CI/CD workflow files or dependencies |
|
||||
| /update-hooks | Update hooks or validation scripts |
|
||||
| /update-docs | Add or update documentation |
|
||||
```
|
||||
|
||||
@@ -1,37 +0,0 @@
|
||||
---
|
||||
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 codebase, typically as a new agent capability or workflow module.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.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/ or .agents/skills/ or .claude/skills/
|
||||
- Document the skill's purpose, usage, and configuration.
|
||||
- Optionally update manifests or documentation if the skill is significant.
|
||||
|
||||
## Notes
|
||||
|
||||
- Treat this as a scaffold, not a hard-coded script.
|
||||
- Update the command if the workflow evolves materially.
|
||||
40
.claude/commands/add-or-update-skill.md
Normal file
40
.claude/commands/add-or-update-skill.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
name: add-or-update-skill
|
||||
description: Workflow command scaffold for add-or-update-skill in everything-claude-code.
|
||||
allowed_tools: ["Bash", "Read", "Write", "Grep", "Glob"]
|
||||
---
|
||||
|
||||
# /add-or-update-skill
|
||||
|
||||
Use this workflow when working on **add-or-update-skill** in `everything-claude-code`.
|
||||
|
||||
## Goal
|
||||
|
||||
Adds a new skill or updates an existing skill, typically for a new workflow, agent, or capability.
|
||||
|
||||
## Common Files
|
||||
|
||||
- `skills/*/SKILL.md`
|
||||
- `.agents/skills/*/SKILL.md`
|
||||
- `.claude/skills/*/SKILL.md`
|
||||
- `AGENTS.md`
|
||||
- `README.md`
|
||||
- `manifests/install-modules.json`
|
||||
|
||||
## 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 a SKILL.md file in skills/<skill-name>/ or .agents/skills/<skill-name>/ or .claude/skills/<skill-name>/
|
||||
- Optionally update AGENTS.md, README.md, or manifests/install-modules.json to reference the new skill
|
||||
- Document the skill's usage and integration points
|
||||
|
||||
## 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-01T22:51:43.152Z",
|
||||
"generatedAt": "2026-04-01T22:57:31.655Z",
|
||||
"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.md"
|
||||
".claude/commands/add-or-update-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.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"moduleFiles": {
|
||||
@@ -211,7 +211,7 @@
|
||||
"workflow-pack": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"files": [
|
||||
@@ -297,8 +297,8 @@
|
||||
},
|
||||
{
|
||||
"moduleId": "workflow-pack",
|
||||
"path": ".claude/commands/add-new-skill.md",
|
||||
"description": "Workflow command scaffold for add-new-skill."
|
||||
"path": ".claude/commands/add-or-update-skill.md",
|
||||
"description": "Workflow command scaffold for add-or-update-skill."
|
||||
}
|
||||
],
|
||||
"workflows": [
|
||||
@@ -311,8 +311,8 @@
|
||||
"path": ".claude/commands/refactoring.md"
|
||||
},
|
||||
{
|
||||
"command": "add-new-skill",
|
||||
"path": ".claude/commands/add-new-skill.md"
|
||||
"command": "add-or-update-skill",
|
||||
"path": ".claude/commands/add-or-update-skill.md"
|
||||
}
|
||||
],
|
||||
"adapters": {
|
||||
@@ -322,7 +322,7 @@
|
||||
"commandPaths": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
]
|
||||
},
|
||||
"codex": {
|
||||
|
||||
@@ -10,5 +10,5 @@
|
||||
"javascript"
|
||||
],
|
||||
"suggestedBy": "ecc-tools-repo-analysis",
|
||||
"createdAt": "2026-04-01T22:52:48.730Z"
|
||||
"createdAt": "2026-04-01T22:58:08.299Z"
|
||||
}
|
||||
@@ -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: Adds a new skill to the codebase, typically as a new agent capability or workflow module.
|
||||
- add-or-update-skill: Adds a new skill or updates an existing skill, typically for a new workflow, agent, or capability.
|
||||
|
||||
## Review Reminder
|
||||
|
||||
|
||||
@@ -5,171 +5,162 @@
|
||||
|
||||
## Overview
|
||||
|
||||
This skill teaches the core development patterns, coding conventions, and common workflows used in the `everything-claude-code` repository. The codebase is primarily JavaScript, with no major framework, and is organized around modular skills, agent definitions, command workflows, and extensible install targets. The repository emphasizes clear documentation, conventional commits, and maintainable architecture for agent and workflow development.
|
||||
This skill introduces the core development patterns, coding conventions, and common workflows for contributing to the `everything-claude-code` repository. The project is JavaScript-based, with no framework dependencies, and emphasizes modularity, agentic skills, and workflow automation. This guide covers file organization, commit conventions, code style, workflow steps, and testing patterns to help you contribute effectively and consistently.
|
||||
|
||||
## Coding Conventions
|
||||
|
||||
- **File Naming:**
|
||||
Use `camelCase` for JavaScript files and directories.
|
||||
*Example:*
|
||||
```
|
||||
scripts/lib/installTargets.js
|
||||
agentPrompts.md
|
||||
```
|
||||
|
||||
- **Import Style:**
|
||||
Use **relative imports** for modules.
|
||||
*Example:*
|
||||
```js
|
||||
const installTarget = require('../lib/installTargets');
|
||||
```
|
||||
|
||||
- **Export Style:**
|
||||
Both CommonJS (`module.exports`) and ES module (`export`) styles are present.
|
||||
*Example (CommonJS):*
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
*Example (ES Module):*
|
||||
```js
|
||||
export function mySkill() { ... }
|
||||
```
|
||||
|
||||
- **Commit Messages:**
|
||||
Use [Conventional Commits](https://www.conventionalcommits.org/).
|
||||
Prefixes: `fix`, `feat`, `docs`, `chore`
|
||||
*Example:*
|
||||
```
|
||||
feat: add Gemini install target support
|
||||
fix: correct agent prompt registration logic
|
||||
```
|
||||
|
||||
- **Documentation:**
|
||||
Each skill or agent should have a `SKILL.md` or `.md` documentation file explaining its purpose and usage.
|
||||
- **File Naming:** Use camelCase for JavaScript files and folders.
|
||||
- Example: `mySkill.js`, `installTarget.js`
|
||||
- **Import Style:** Use relative imports.
|
||||
- Example:
|
||||
```js
|
||||
const helper = require('./utils/helper');
|
||||
```
|
||||
- **Export Style:** Mixed (both CommonJS and ES module styles may be present).
|
||||
- Example (CommonJS):
|
||||
```js
|
||||
module.exports = function mySkill() { ... };
|
||||
```
|
||||
- Example (ESM):
|
||||
```js
|
||||
export default function mySkill() { ... }
|
||||
```
|
||||
- **Commit Messages:** Follow [Conventional Commits](https://www.conventionalcommits.org/) with prefixes such as `fix`, `feat`, `docs`, `chore`.
|
||||
- Example: `feat: add support for new install target`
|
||||
- **Test Files:** Use the pattern `*.test.js` for test files.
|
||||
|
||||
## Workflows
|
||||
|
||||
### Add New Skill
|
||||
**Trigger:** When introducing a new skill for agents or workflows
|
||||
### Add or Update a Skill
|
||||
**Trigger:** When introducing or updating a workflow, agent, or capability
|
||||
**Command:** `/add-skill`
|
||||
|
||||
1. Create a new `SKILL.md` file under `skills/`, `.agents/skills/`, or `.claude/skills/`.
|
||||
2. Document the skill's purpose, usage, and configuration.
|
||||
3. Optionally update manifests or documentation if the skill is significant.
|
||||
1. Create or update a `SKILL.md` file in one of:
|
||||
- `skills/<skill-name>/SKILL.md`
|
||||
- `.agents/skills/<skill-name>/SKILL.md`
|
||||
- `.claude/skills/<skill-name>/SKILL.md`
|
||||
2. Optionally update `AGENTS.md`, `README.md`, or `manifests/install-modules.json` to reference the new skill.
|
||||
3. Document the skill's usage and integration points.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
skills/myNewSkill/SKILL.md
|
||||
**Example:**
|
||||
```bash
|
||||
/add-skill
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add New Agent or Agent Prompt
|
||||
**Trigger:** When introducing a new agent persona or capability
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create a new agent definition (e.g., `agents/myAgent.md` or `.opencode/prompts/agents/myAgent.txt`).
|
||||
2. Register the agent in the relevant configuration file (e.g., `.opencode/opencode.json`).
|
||||
3. Update `AGENTS.md` or related documentation.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
agents/supportAgent.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Command Workflow
|
||||
**Trigger:** When introducing or improving a workflow command
|
||||
### Add or Update a Command
|
||||
**Trigger:** When adding a new CLI command, workflow, or extending command capabilities
|
||||
**Command:** `/add-command`
|
||||
|
||||
1. Create or update a command file under `commands/` (e.g., `commands/review.md`).
|
||||
2. Optionally update related documentation or scripts.
|
||||
3. Address review feedback and refine command logic.
|
||||
1. Create or update a markdown file in `commands/` (e.g., `commands/<command>.md`).
|
||||
2. Optionally update related documentation (`README.md`, `AGENTS.md`).
|
||||
3. If the command is part of a workflow, update or create associated artifacts or scripts.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-command
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add Install Target or Adapter
|
||||
**Trigger:** When supporting a new platform or integration
|
||||
### Add or Update an Agent
|
||||
**Trigger:** When introducing a new agent or updating agent logic
|
||||
**Command:** `/add-agent`
|
||||
|
||||
1. Create or update agent definition markdown in `agents/<agent-name>.md` or `.opencode/prompts/agents/<agent>.txt`.
|
||||
2. Register or update the agent in `opencode.json` or related config.
|
||||
3. Update `AGENTS.md` with new agent details.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/add-agent
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update an Install Target
|
||||
**Trigger:** When supporting a new platform/tool for installation/integration
|
||||
**Command:** `/add-install-target`
|
||||
|
||||
1. Add new install scripts and documentation under a dot-directory (e.g., `.gemini/`, `.codebuddy/`).
|
||||
2. Update `manifests/install-modules.json` and relevant schema files.
|
||||
3. Implement or update `scripts/lib/install-targets/*.js` for the new target.
|
||||
4. Add or update tests for the install target.
|
||||
1. Create or update install scripts (`.sh`/`.js`) and documentation in a dot-directory (e.g., `.codebuddy/`, `.gemini/`).
|
||||
2. Update `manifests/install-modules.json` and `schemas/ecc-install-config.schema.json`.
|
||||
3. Update `scripts/lib/install-manifests.js` and `scripts/lib/install-targets/<target>.js`.
|
||||
4. Add or update tests for install targets.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
.gemini/install.sh
|
||||
scripts/lib/install-targets/gemini.js
|
||||
tests/lib/install-targets.test.js
|
||||
**Example:**
|
||||
```bash
|
||||
/add-install-target
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Refactor or Collapse Commands to Skills
|
||||
**Trigger:** When modernizing command logic under the skills architecture
|
||||
**Command:** `/refactor-to-skill`
|
||||
|
||||
1. Update or remove `commands/*.md` files.
|
||||
2. Add or update `skills/*/SKILL.md` files.
|
||||
3. Update documentation (`README.md`, `AGENTS.md`, `WORKING-CONTEXT.md`, etc.).
|
||||
4. Update manifests if required.
|
||||
|
||||
---
|
||||
|
||||
### Documentation and Guidance Update
|
||||
**Trigger:** When clarifying, updating, or adding documentation
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or create documentation files (`README.md`, `WORKING-CONTEXT.md`, `docs/*.md`, etc.).
|
||||
2. Sync or update guidance in multiple language versions if needed.
|
||||
3. Optionally update related configuration or manifest files.
|
||||
|
||||
---
|
||||
|
||||
### CI/CD Workflow Update
|
||||
**Trigger:** When improving or fixing CI/CD processes
|
||||
### Add or Update CI Workflow
|
||||
**Trigger:** When updating CI workflows, adding new checks, or bumping dependencies
|
||||
**Command:** `/update-ci`
|
||||
|
||||
1. Edit `.github/workflows/*.yml` files.
|
||||
2. Update lockfiles (`package-lock.json`, `yarn.lock`) or validation scripts.
|
||||
3. Update or add test files for CI/CD logic.
|
||||
1. Edit or add files in `.github/workflows/`.
|
||||
2. Update `package.json` or `yarn.lock` if dependency-related.
|
||||
3. Test CI to ensure the new workflow or dependency works as intended.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-ci
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Update Hooks or Validation Scripts
|
||||
**Trigger:** When improving or fixing pre/post hooks, or validation logic for edits and CI
|
||||
**Command:** `/update-hooks`
|
||||
|
||||
1. Edit `hooks/hooks.json` and supporting scripts in `scripts/hooks/`.
|
||||
2. Update or add tests in `tests/hooks/` or `tests/scripts/`.
|
||||
3. Optionally update related documentation.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-hooks
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Add or Update Documentation
|
||||
**Trigger:** When documenting new workflows, updating guides, or adding troubleshooting info
|
||||
**Command:** `/update-docs`
|
||||
|
||||
1. Edit or add markdown files in `docs/`, `WORKING-CONTEXT.md`, or `the-shortform-guide.md`.
|
||||
2. Update `README.md` and/or `README.zh-CN.md`.
|
||||
3. Optionally update related skill or agent docs.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
/update-docs
|
||||
```
|
||||
|
||||
## Testing Patterns
|
||||
|
||||
- **Test Files:**
|
||||
Test files follow the pattern `*.test.js`.
|
||||
- **Test Files:** Place tests in the same directory as the code or in a `tests/` directory, using the `*.test.js` naming convention.
|
||||
- **Framework:** No specific testing framework detected; use standard JavaScript test runners (e.g., Jest, Mocha) as appropriate.
|
||||
- **Example Test File:**
|
||||
```js
|
||||
// mySkill.test.js
|
||||
const mySkill = require('./mySkill');
|
||||
|
||||
- **Framework:**
|
||||
No specific testing framework detected; structure your tests in standard Node.js or your preferred test runner.
|
||||
|
||||
*Example:*
|
||||
```
|
||||
tests/lib/install-targets.test.js
|
||||
```
|
||||
|
||||
- **Test Example:**
|
||||
```js
|
||||
// install-targets.test.js
|
||||
const installTarget = require('../../scripts/lib/install-targets/gemini');
|
||||
|
||||
test('should install Gemini target', () => {
|
||||
expect(installTarget()).toBe(true);
|
||||
});
|
||||
```
|
||||
test('should return expected result', () => {
|
||||
expect(mySkill('input')).toBe('expected output');
|
||||
});
|
||||
```
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Purpose |
|
||||
|--------------------|----------------------------------------------------------------|
|
||||
| /add-skill | Add a new skill module and document it |
|
||||
| /add-agent | Add a new agent definition or prompt |
|
||||
| /add-command | Add or update a command workflow |
|
||||
| /add-install-target| Add a new install target or adapter |
|
||||
| /refactor-to-skill | Refactor commands into skill-based modules |
|
||||
| /update-docs | Update documentation or guidance files |
|
||||
| /update-ci | Update CI/CD workflows, lockfiles, or validation scripts |
|
||||
| Command | Purpose |
|
||||
|---------------------|--------------------------------------------------------------|
|
||||
| /add-skill | Add or update a skill (workflow, agent, or capability) |
|
||||
| /add-command | Add or update a command file for new or extended workflows |
|
||||
| /add-agent | Add or update an agent definition |
|
||||
| /add-install-target | Add or update an install target for external integrations |
|
||||
| /update-ci | Add or update CI/CD workflow files or dependencies |
|
||||
| /update-hooks | Update hooks or validation scripts |
|
||||
| /update-docs | Add or update documentation |
|
||||
```
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
"commandFiles": [
|
||||
".claude/commands/feature-development.md",
|
||||
".claude/commands/refactoring.md",
|
||||
".claude/commands/add-new-skill.md"
|
||||
".claude/commands/add-or-update-skill.md"
|
||||
],
|
||||
"updatedAt": "2026-04-01T22:51:43.152Z"
|
||||
"updatedAt": "2026-04-01T22:57:31.655Z"
|
||||
}
|
||||
Reference in New Issue
Block a user