devloom 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.ai/core.dsl +44 -0
- package/.ai/skills.dsl +39 -0
- package/.ai/verify.dsl +97 -0
- package/.ai/workflow.dsl +81 -0
- package/.opencode/themes/devloom-night-owl.json +103 -0
- package/GUIDE.md +572 -115
- package/README.md +583 -109
- package/SECURITY.md +93 -0
- package/agents/devloom-developer-flash.md +31 -0
- package/agents/devloom-developer-senior.md +32 -0
- package/agents/devloom-developer.md +21 -55
- package/agents/devloom-documenter-flash.md +28 -0
- package/agents/devloom-documenter.md +17 -56
- package/agents/devloom-orchestrator.md +236 -356
- package/agents/devloom-planner-flash.md +34 -0
- package/agents/devloom-planner-senior.md +35 -0
- package/agents/devloom-planner.md +36 -0
- package/agents/devloom-qa-flash.md +32 -0
- package/agents/devloom-qa.md +21 -83
- package/agents/devloom-security-senior.md +35 -0
- package/agents/devloom-security.md +34 -0
- package/agents/devloom-verifier.md +33 -0
- package/agents/devloom-vision.md +113 -0
- package/agents/devloom-visual-critic.md +102 -0
- package/agents/devloom-visual-director.md +84 -0
- package/commands/devloom-agents.md +49 -0
- package/commands/devloom-auto.md +11 -0
- package/commands/devloom-context.md +82 -0
- package/commands/devloom-deepseek-mimo.md +11 -0
- package/commands/devloom-deepseek.md +11 -0
- package/commands/devloom-free.md +11 -0
- package/commands/devloom-go-economy.md +11 -0
- package/commands/devloom-go-flash.md +11 -0
- package/commands/devloom-go.md +11 -0
- package/commands/devloom-init.md +28 -50
- package/commands/devloom-loop-status.md +25 -0
- package/commands/devloom-loop.md +36 -0
- package/commands/devloom-mimo.md +11 -0
- package/commands/devloom-plan.md +13 -0
- package/commands/devloom-refresh.md +22 -0
- package/commands/devloom-resume.md +30 -49
- package/commands/devloom-save.md +69 -0
- package/commands/devloom-status.md +9 -18
- package/commands/devloom.md +99 -67
- package/dist/agents.d.ts +30 -0
- package/dist/agents.d.ts.map +1 -0
- package/dist/agents.js +139 -0
- package/dist/agents.js.map +1 -0
- package/dist/bootstrap.d.ts +56 -0
- package/dist/bootstrap.d.ts.map +1 -0
- package/dist/bootstrap.js +116 -0
- package/dist/bootstrap.js.map +1 -0
- package/dist/constraints.d.ts +5 -0
- package/dist/constraints.d.ts.map +1 -0
- package/dist/constraints.js +45 -0
- package/dist/constraints.js.map +1 -0
- package/dist/context.d.ts +42 -0
- package/dist/context.d.ts.map +1 -0
- package/dist/context.js +636 -0
- package/dist/context.js.map +1 -0
- package/dist/guard.d.ts +19 -0
- package/dist/guard.d.ts.map +1 -0
- package/dist/guard.js +418 -0
- package/dist/guard.js.map +1 -0
- package/dist/loop.d.ts +64 -0
- package/dist/loop.d.ts.map +1 -0
- package/dist/loop.js +164 -0
- package/dist/loop.js.map +1 -0
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +101 -1
- package/dist/plugin.js.map +1 -1
- package/dist/tui-agents.d.ts +61 -0
- package/dist/tui-agents.d.ts.map +1 -0
- package/dist/tui-agents.js +89 -0
- package/dist/tui-agents.js.map +1 -0
- package/dist/tui.d.ts +6 -0
- package/dist/tui.d.ts.map +1 -0
- package/dist/tui.js +92 -0
- package/dist/tui.js.map +1 -0
- package/dist/worktree.d.ts +46 -0
- package/dist/worktree.d.ts.map +1 -0
- package/dist/worktree.js +272 -0
- package/dist/worktree.js.map +1 -0
- package/package.json +46 -6
- package/patterns/changelog-drafter.md +38 -0
- package/patterns/ci-sweeper.md +40 -0
- package/patterns/daily-triage.md +37 -0
- package/patterns/dependency-sweeper.md +40 -0
- package/patterns/design-audit.md +63 -0
- package/patterns/issue-triage.md +37 -0
- package/patterns/post-merge-cleanup.md +34 -0
- package/patterns/pr-babysitter.md +37 -0
- package/patterns/registry.yaml +52 -0
- package/postinstall.mjs +264 -64
- package/project/README.md +29 -0
- package/protocol/agent-contracts.md +27 -0
- package/protocol/artifact-system.md +53 -0
- package/protocol/model-routing.md +194 -0
- package/protocol/orchestrator-core.md +43 -0
- package/protocol/project-system.md +45 -0
- package/protocol/rules.md +18 -0
- package/protocol/verification-policy.md +48 -0
- package/scripts/briefing.mjs +192 -0
- package/scripts/loop-run.mjs +205 -0
- package/scripts/model-capabilities.mjs +194 -0
- package/scripts/plugin-cache.mjs +269 -0
- package/scripts/profile.mjs +755 -0
- package/scripts/visual-benchmark.mjs +149 -0
- package/scripts/worktree.mjs +445 -0
- package/skills/build/development.md +33 -0
- package/skills/build/live-docs.md +38 -0
- package/skills/build/simplify.md +50 -0
- package/skills/build/vision-analysis.md +98 -0
- package/skills/design/app-design.md +31 -0
- package/skills/design/design-grounding.md +30 -0
- package/skills/design/design-system.md +27 -0
- package/skills/design/game-design.md +35 -0
- package/skills/design/motion-design.md +34 -0
- package/skills/design/visual-direction.md +32 -0
- package/skills/design/web-design.md +33 -0
- package/skills/loop/changelog-drafter.md +32 -0
- package/skills/loop/ci-sweeper.md +24 -0
- package/skills/loop/constraints.md +21 -0
- package/skills/loop/dependency-sweeper.md +24 -0
- package/skills/loop/design-audit.md +67 -0
- package/skills/loop/issue-triage.md +27 -0
- package/skills/loop/post-merge-cleanup.md +24 -0
- package/skills/loop/pr-babysitter.md +26 -0
- package/skills/loop/triage.md +25 -0
- package/skills/loop/verifier.md +20 -0
- package/skills/meta/skill-discovery.md +23 -0
- package/skills/plan/planning.md +27 -0
- package/skills/plan/verification-planning.md +40 -0
- package/skills/review/security-review.md +63 -0
- package/skills/ship/documentation.md +11 -0
- package/skills/verify/app-verification.md +19 -0
- package/skills/verify/quality-assurance.md +17 -0
- package/skills/verify/visual-critique.md +30 -0
- package/skills/verify/visual-quality-gate.md +29 -0
- package/skills/verify/visual-regression.md +25 -0
- package/agents/devloom-analyst.md +0 -83
- package/agents/devloom-architect.md +0 -88
package/SECURITY.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
| Version | Supported |
|
|
6
|
+
|---------|-----------|
|
|
7
|
+
| 1.x | Active development |
|
|
8
|
+
|
|
9
|
+
## Reporting a Vulnerability
|
|
10
|
+
|
|
11
|
+
DevLoom is an OpenCode plugin that executes AI-generated code and shell commands
|
|
12
|
+
in your development environment. While we take precautions, **you should review
|
|
13
|
+
all generated code before running it in production**.
|
|
14
|
+
|
|
15
|
+
To report a security vulnerability:
|
|
16
|
+
|
|
17
|
+
1. **Do NOT** open a public GitHub issue.
|
|
18
|
+
2. Email the maintainer directly (see `package.json` for contact) with:
|
|
19
|
+
- Description of the vulnerability
|
|
20
|
+
- Steps to reproduce
|
|
21
|
+
- Affected versions
|
|
22
|
+
- Any suggested fix (optional)
|
|
23
|
+
3. You should receive a response within 72 hours.
|
|
24
|
+
4. We will work with you to understand the issue and release a fix.
|
|
25
|
+
5. Credit will be given to reporters in the release notes.
|
|
26
|
+
|
|
27
|
+
## Security Assumptions
|
|
28
|
+
|
|
29
|
+
- **User permissions**: DevLoom runs with the same permissions as the user who
|
|
30
|
+
installed it. It does not escalate privileges.
|
|
31
|
+
- **Agent trust model**: AI agents execute tasks described in their agent files
|
|
32
|
+
(`agents/*.md`). They operate autonomously within the bounds defined by the
|
|
33
|
+
agent's `permission` block (edit, bash, webfetch, etc.).
|
|
34
|
+
- **Prompt sanitization**: User prompts are truncated to 4000 characters and
|
|
35
|
+
control characters are stripped. However, AI agents may still follow
|
|
36
|
+
instructions embedded in prompts, repository docs, comments, issues, and
|
|
37
|
+
generated files. **Prompt injection risk is present** — always review
|
|
38
|
+
agent outputs critically, especially when using autonomous agents with
|
|
39
|
+
bash/edit permissions.
|
|
40
|
+
- **Network access**: Agents may fetch external resources via `webfetch`.
|
|
41
|
+
Model API calls go through OpenCode's infrastructure.
|
|
42
|
+
- **Go models improve quality but do not remove the need for review**:
|
|
43
|
+
OpenCode Go models (GLM 5.1, Kimi K2.6, DeepSeek V4 Pro/Flash) produce
|
|
44
|
+
higher-quality output and follow instructions more reliably than free-tier
|
|
45
|
+
models, but they are still AI systems. All generated code must be reviewed
|
|
46
|
+
before deployment.
|
|
47
|
+
|
|
48
|
+
## Autonomous Agent Risks
|
|
49
|
+
|
|
50
|
+
DevLoom agents operate autonomously with edit, bash, and webfetch permissions.
|
|
51
|
+
This introduces unique security considerations:
|
|
52
|
+
|
|
53
|
+
- **Hard delegation**: The orchestrator agent has `edit: deny`, `write: deny`,
|
|
54
|
+
`patch: deny` at the OpenCode permission level. Code production is only
|
|
55
|
+
possible via `task()` delegation to sub-agents. Sub-agents have `task: deny`,
|
|
56
|
+
preventing delegation chains. This is enforced by OpenCode itself, not by the
|
|
57
|
+
plugin — it survives plugin reloads.
|
|
58
|
+
- **Least privilege**: Each agent's `permission` block should be restricted to
|
|
59
|
+
the minimum required for its role. Verifier agents (route, form, a11y, API,
|
|
60
|
+
visual, responsive, motion) do not need write access to production source
|
|
61
|
+
files, and the visual-director / visual-critic agents are fully read-only
|
|
62
|
+
(`edit/write/patch/bash: deny`) — they only emit briefs and verdicts.
|
|
63
|
+
- **Visual loop cap**: visual-director → critic → refine cycles are capped at
|
|
64
|
+
3 iterations per ticket, mirroring the defect retry limit — agents are not
|
|
65
|
+
allowed to loop on visual polish indefinitely.
|
|
66
|
+
- **bash permissions**: Agents with `bash: allow` can execute arbitrary shell
|
|
67
|
+
commands. Never grant bash permission to agents that process untrusted input.
|
|
68
|
+
The orchestrator uses bash ONLY for state persistence in `.opencode/devloom/`
|
|
69
|
+
— sub-agents have full bash for implementation.
|
|
70
|
+
- **Destructive commands**: The `bash` tool should not be used to run
|
|
71
|
+
destructive commands (rm -rf, drop table, etc.) without explicit user
|
|
72
|
+
confirmation. OpenCode's permission system can prompt for confirmation.
|
|
73
|
+
- **Defect retry limits**: The orchestrator enforces a max of 3 retry cycles
|
|
74
|
+
per defect. Beyond that, the ticket is marked blocked and reported — agents
|
|
75
|
+
are not allowed to loop indefinitely on the same issue.
|
|
76
|
+
|
|
77
|
+
## Best Practices
|
|
78
|
+
|
|
79
|
+
1. **Pin versions**: Use exact version pins in `package.json` rather than ranges.
|
|
80
|
+
2. **Review changes**: Always review code, tests, and documentation generated
|
|
81
|
+
by DevLoom before committing or deploying.
|
|
82
|
+
3. **Limit permissions**: The `permission` block in agent files controls what
|
|
83
|
+
agents can do. Review and restrict as needed.
|
|
84
|
+
4. **Audit dependencies**: Run `npm audit` regularly.
|
|
85
|
+
5. **Use `.opencode/` directory isolation**: Keep DevLoom state in
|
|
86
|
+
`.opencode/devloom/` — add this directory to your `.gitignore` if you do not
|
|
87
|
+
want execution state tracked in version control.
|
|
88
|
+
6. **Prefer Go models for security-sensitive work**: Higher-quality models
|
|
89
|
+
(opencode-go/glm-5.1, opencode-go/kimi-k2.6) follow instructions more
|
|
90
|
+
reliably and are less susceptible to prompt injection than free-tier models.
|
|
91
|
+
7. **Safe defaults for destructive commands**: Use `--dry-run` flags when
|
|
92
|
+
available. Add explicit confirmation steps in agent prompts for irreversible
|
|
93
|
+
operations.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "DevLoom Developer Flash: callable by the orchestrator for simple ticket implementation and defect fixes"
|
|
3
|
+
mode: subagent
|
|
4
|
+
model: opencode-go/deepseek-v4-flash
|
|
5
|
+
permission:
|
|
6
|
+
edit: allow
|
|
7
|
+
bash: allow
|
|
8
|
+
task: deny
|
|
9
|
+
external_directory:
|
|
10
|
+
"~/.config/opencode/**": allow
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# DevLoom Developer Flash
|
|
14
|
+
|
|
15
|
+
ENGLISH ONLY: All output MUST be in English. Never use any other language.
|
|
16
|
+
|
|
17
|
+
BEFORE SCANNING: if `.opencode/devloom/context/briefing.md` exists, read it FIRST and start from its file map — never re-read files it already summarizes.
|
|
18
|
+
|
|
19
|
+
COMPLIANCE: Follow the RULES below + your skill LOAD. No rule may be skipped.
|
|
20
|
+
RULES: EN | SOLID+TDD+CleanArch | tests+regr required | doing<=1 | FILES: use .opencode/devloom/.tmp/ | peer-review for high-risk | degrade on 2x failure
|
|
21
|
+
LOAD: ~/.config/opencode/skills/build/development.md|~/.config/opencode/skills/build/simplify.md
|
|
22
|
+
|
|
23
|
+
ROLE: implement one simple ticket OR fix one straightforward defect
|
|
24
|
+
READ: PLAN|ticket json|defect|changed source
|
|
25
|
+
RULES:
|
|
26
|
+
- one ticket/defect at a time
|
|
27
|
+
- TDD: tests first (new logic) or failing repro first (bug)
|
|
28
|
+
- surgical, smallest-correct diff; SOLID + CleanArch boundaries
|
|
29
|
+
- root-cause fix only — NO workarounds, hacks, or symptom patches
|
|
30
|
+
- no unrelated refactor; OfficialDocsFirst for stack-specific code
|
|
31
|
+
OUT: DEVELOPER_COMPLETE (ticket) | REPAIR_COMPLETE (defect)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "DevLoom Developer Senior: callable by the orchestrator for complex ticket implementation and defect fixes"
|
|
3
|
+
mode: subagent
|
|
4
|
+
model: opencode-go/kimi-k3
|
|
5
|
+
permission:
|
|
6
|
+
edit: allow
|
|
7
|
+
bash: allow
|
|
8
|
+
task: deny
|
|
9
|
+
external_directory:
|
|
10
|
+
"~/.config/opencode/**": allow
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# DevLoom Developer Senior
|
|
14
|
+
|
|
15
|
+
ENGLISH ONLY: All output MUST be in English. Never use any other language.
|
|
16
|
+
|
|
17
|
+
BEFORE SCANNING: if `.opencode/devloom/context/briefing.md` exists, read it FIRST and start from its file map — never re-read files it already summarizes.
|
|
18
|
+
|
|
19
|
+
COMPLIANCE: Follow the RULES below + your skill LOAD. No rule may be skipped.
|
|
20
|
+
RULES: EN | SOLID+TDD+CleanArch | tests+regr required | doing<=1 | FILES: use .opencode/devloom/.tmp/ | peer-review for high-risk | degrade on 2x failure
|
|
21
|
+
LOAD: ~/.config/opencode/skills/build/development.md|~/.config/opencode/skills/build/simplify.md
|
|
22
|
+
|
|
23
|
+
ROLE: implement one complex ticket OR fix one hard defect
|
|
24
|
+
READ: PLAN|ticket json|defect|changed source
|
|
25
|
+
RULES:
|
|
26
|
+
- one ticket/defect at a time
|
|
27
|
+
- TDD: tests first (new logic) or failing repro first (bug)
|
|
28
|
+
- surgical, smallest-correct diff; SOLID + CleanArch boundaries
|
|
29
|
+
- root-cause fix only — NO workarounds, hacks, or symptom patches
|
|
30
|
+
- no unrelated refactor; OfficialDocsFirst for stack-specific code
|
|
31
|
+
- deep multi-file analysis for complex cross-cutting changes
|
|
32
|
+
OUT: DEVELOPER_COMPLETE (ticket) | REPAIR_COMPLETE (defect)
|
|
@@ -1,66 +1,32 @@
|
|
|
1
1
|
---
|
|
2
|
+
description: "DevLoom Developer: callable by the orchestrator for ticket implementation and defect fixes"
|
|
2
3
|
mode: subagent
|
|
3
|
-
model: opencode/
|
|
4
|
-
hidden: true
|
|
4
|
+
model: opencode-go/kimi-k2.7-code
|
|
5
5
|
permission:
|
|
6
6
|
edit: allow
|
|
7
7
|
bash: allow
|
|
8
|
+
task: deny
|
|
9
|
+
external_directory:
|
|
10
|
+
"~/.config/opencode/**": allow
|
|
8
11
|
---
|
|
9
12
|
|
|
10
|
-
# DevLoom Developer
|
|
13
|
+
# DevLoom Developer
|
|
11
14
|
|
|
12
|
-
|
|
15
|
+
ENGLISH ONLY: All output MUST be in English. Never use any other language.
|
|
13
16
|
|
|
14
|
-
|
|
15
|
-
- FE task -> cat ~/.config/opencode/skills/build/frontend-development.md
|
|
16
|
-
- BE task -> cat ~/.config/opencode/skills/build/backend-development.md + cat ~/.config/opencode/skills/build/api-design.md
|
|
17
|
-
- API design -> cat ~/.config/opencode/skills/build/api-design.md
|
|
18
|
-
- Testing -> cat ~/.config/opencode/skills/build/test-driven-development.md + cat ~/.config/opencode/skills/verify/quality-assurance.md
|
|
19
|
-
- Security -> cat ~/.config/opencode/skills/review/security-review.md
|
|
20
|
-
- Performance -> cat ~/.config/opencode/skills/review/performance-review.md
|
|
21
|
-
- Debugging -> cat ~/.config/opencode/skills/verify/debugging.md
|
|
22
|
-
- Documentation -> cat ~/.config/opencode/skills/ship/documentation.md
|
|
23
|
-
- Requirements -> cat ~/.config/opencode/skills/define/requirements-analysis.md
|
|
24
|
-
- Planning -> cat ~/.config/opencode/skills/plan/architecture-planning.md
|
|
17
|
+
BEFORE SCANNING: if `.opencode/devloom/context/briefing.md` exists, read it FIRST and start from its file map — never re-read files it already summarizes.
|
|
25
18
|
|
|
26
|
-
|
|
27
|
-
|
|
19
|
+
COMPLIANCE: Follow the RULES below + your skill LOAD. No rule may be skipped.
|
|
20
|
+
RULES: EN | SOLID+TDD+CleanArch | tests+regr required | doing<=1 | FILES: use .opencode/devloom/.tmp/ | peer-review for high-risk | degrade on 2x failure
|
|
21
|
+
LOAD: ~/.config/opencode/skills/build/development.md|~/.config/opencode/skills/build/simplify.md
|
|
28
22
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
cat .opencode/devloom/plan.md
|
|
40
|
-
```
|
|
41
|
-
|
|
42
|
-
3. Read the relevant source files **before writing any code**. Understand:
|
|
43
|
-
- Naming conventions (camelCase, snake_case, kebab-case)
|
|
44
|
-
- Import patterns (default vs named exports, path aliases)
|
|
45
|
-
- Error handling patterns (throw, Result type, error codes)
|
|
46
|
-
- Existing utility functions you should reuse
|
|
47
|
-
|
|
48
|
-
4. Implement the task **once**:
|
|
49
|
-
- Match the existing code style exactly.
|
|
50
|
-
- Handle errors and all edge cases described in the acceptance criteria.
|
|
51
|
-
- Add appropriate types and interfaces (TypeScript) or type hints (Python).
|
|
52
|
-
- Make minimal, focused changes — do not refactor unrelated code.
|
|
53
|
-
- If the task requires a new file, match the file naming convention of adjacent files.
|
|
54
|
-
- **Do NOT make multiple iterations or trial-and-error changes.** Implement once, test once, report.
|
|
55
|
-
|
|
56
|
-
5. If a QA failure report is included in your prompt, read it carefully and fix
|
|
57
|
-
**only** the reported issues. Do not introduce unrelated changes.
|
|
58
|
-
- **Max 1 fix attempt per QA failure report.** After your fix, report completion and let QA re-verify.
|
|
59
|
-
- If QA fails again on the same issue, the orchestrator will skip the task (not loop forever).
|
|
60
|
-
|
|
61
|
-
6. After implementation, report with the exact string:
|
|
62
|
-
```
|
|
63
|
-
DEVELOPER_COMPLETE: [task title]
|
|
64
|
-
Files modified: [comma-separated list]
|
|
65
|
-
Summary: [1–3 sentence description of changes]
|
|
66
|
-
```
|
|
23
|
+
ROLE: implement one ticket OR fix one defect
|
|
24
|
+
READ: PLAN|ticket json|defect|changed source|.opencode/devloom/context/design.md (DESIGN_CONTRACT, required for VISUAL_REQUIRED tickets)
|
|
25
|
+
RULES:
|
|
26
|
+
- one ticket/defect at a time
|
|
27
|
+
- TDD: tests first (new logic) or failing repro first (bug)
|
|
28
|
+
- surgical, smallest-correct diff; SOLID + CleanArch boundaries
|
|
29
|
+
- root-cause fix only — NO workarounds, hacks, or symptom patches
|
|
30
|
+
- no unrelated refactor; OfficialDocsFirst for stack-specific code
|
|
31
|
+
- VISUAL_REQUIRED tickets: implement to the DESIGN_CONTRACT (tokens, spacing, type, motion); when done emit `VISUAL_IMPLEMENTATION_COMPLETE` with touched UI routes/components for the critic/verifier loop; backend tickets never emit it
|
|
32
|
+
OUT: DEVELOPER_COMPLETE (ticket) | REPAIR_COMPLETE (defect)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "DevLoom Documenter Flash: callable by the orchestrator for lightweight documentation and state updates"
|
|
3
|
+
mode: subagent
|
|
4
|
+
model: opencode-go/deepseek-v4-flash
|
|
5
|
+
permission:
|
|
6
|
+
edit: allow
|
|
7
|
+
bash: allow
|
|
8
|
+
task: deny
|
|
9
|
+
external_directory:
|
|
10
|
+
"~/.config/opencode/**": allow
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# DevLoom Documenter Flash
|
|
14
|
+
|
|
15
|
+
ENGLISH ONLY: All output MUST be in English. Never use any other language.
|
|
16
|
+
|
|
17
|
+
BEFORE SCANNING: if `.opencode/devloom/context/briefing.md` exists, read it FIRST and start from its file map — never re-read files it already summarizes.
|
|
18
|
+
|
|
19
|
+
COMPLIANCE: Follow the RULES below + your skill LOAD. No rule may be skipped.
|
|
20
|
+
RULES: EN | SOLID+TDD+CleanArch | tests+regr required | doing<=1 | FILES: use .opencode/devloom/.tmp/ | peer-review for high-risk | degrade on 2x failure
|
|
21
|
+
LOAD: ~/.config/opencode/skills/ship/documentation.md
|
|
22
|
+
|
|
23
|
+
ROLE: update docs+state (lightweight)
|
|
24
|
+
DO:
|
|
25
|
+
- document implemented behavior only
|
|
26
|
+
- update README/api/setup if changed
|
|
27
|
+
- update REQ checks + project reports/state
|
|
28
|
+
OUT: DOCUMENTER_COMPLETE
|
|
@@ -1,67 +1,28 @@
|
|
|
1
1
|
---
|
|
2
|
+
description: "DevLoom Documenter: callable by the orchestrator for documentation and state updates"
|
|
2
3
|
mode: subagent
|
|
3
|
-
model: opencode/deepseek-v4-flash
|
|
4
|
-
hidden: true
|
|
4
|
+
model: opencode-go/deepseek-v4-flash
|
|
5
5
|
permission:
|
|
6
6
|
edit: allow
|
|
7
7
|
bash: allow
|
|
8
|
+
task: deny
|
|
9
|
+
external_directory:
|
|
10
|
+
"~/.config/opencode/**": allow
|
|
8
11
|
---
|
|
9
12
|
|
|
10
|
-
# DevLoom Documenter
|
|
13
|
+
# DevLoom Documenter
|
|
11
14
|
|
|
12
|
-
|
|
15
|
+
ENGLISH ONLY: All output MUST be in English. Never use any other language.
|
|
13
16
|
|
|
14
|
-
|
|
15
|
-
- FE task -> cat ~/.config/opencode/skills/build/frontend-development.md
|
|
16
|
-
- BE task -> cat ~/.config/opencode/skills/build/backend-development.md + cat ~/.config/opencode/skills/build/api-design.md
|
|
17
|
-
- API design -> cat ~/.config/opencode/skills/build/api-design.md
|
|
18
|
-
- Testing -> cat ~/.config/opencode/skills/build/test-driven-development.md + cat ~/.config/opencode/skills/verify/quality-assurance.md
|
|
19
|
-
- Security -> cat ~/.config/opencode/skills/review/security-review.md
|
|
20
|
-
- Performance -> cat ~/.config/opencode/skills/review/performance-review.md
|
|
21
|
-
- Debugging -> cat ~/.config/opencode/skills/verify/debugging.md
|
|
22
|
-
- Documentation -> cat ~/.config/opencode/skills/ship/documentation.md
|
|
23
|
-
- Requirements -> cat ~/.config/opencode/skills/define/requirements-analysis.md
|
|
24
|
-
- Planning -> cat ~/.config/opencode/skills/plan/architecture-planning.md
|
|
17
|
+
BEFORE SCANNING: if `.opencode/devloom/context/briefing.md` exists, read it FIRST and start from its file map — never re-read files it already summarizes.
|
|
25
18
|
|
|
26
|
-
|
|
27
|
-
|
|
19
|
+
COMPLIANCE: Follow the RULES below + your skill LOAD. No rule may be skipped.
|
|
20
|
+
RULES: EN | SOLID+TDD+CleanArch | tests+regr required | doing<=1 | FILES: use .opencode/devloom/.tmp/ | peer-review for high-risk | degrade on 2x failure
|
|
21
|
+
LOAD: ~/.config/opencode/skills/ship/documentation.md
|
|
28
22
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
cat .opencode/devloom/plan.md
|
|
37
|
-
grep -E "^\- \[x\]" .opencode/devloom/plan.md
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
2. Read the current `README.md` (if it exists):
|
|
41
|
-
```bash
|
|
42
|
-
cat README.md 2>/dev/null || echo "No README.md found"
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
3. Update `README.md` to reflect the new state of the project:
|
|
46
|
-
- **New features**: add a section or bullet describing what was built.
|
|
47
|
-
- **Changed APIs**: update any endpoint documentation, function signatures,
|
|
48
|
-
or configuration options that changed.
|
|
49
|
-
- **Setup changes**: update installation, environment variable, or
|
|
50
|
-
configuration instructions if they changed.
|
|
51
|
-
- **Usage examples**: add or update code examples for new functionality.
|
|
52
|
-
- Do **not** remove existing documentation unless it is factually incorrect.
|
|
53
|
-
|
|
54
|
-
4. Update or create API documentation if applicable:
|
|
55
|
-
- If an `openapi.yaml` / `swagger.json` exists, update it to reflect new endpoints.
|
|
56
|
-
- If inline JSDoc/docstrings are missing on new public functions, add them.
|
|
57
|
-
|
|
58
|
-
5. Update `.opencode/devloom/requirements.md` to mark acceptance criteria as satisfied:
|
|
59
|
-
```bash
|
|
60
|
-
cat .opencode/devloom/requirements.md
|
|
61
|
-
```
|
|
62
|
-
Check off any `- [ ] AC-XX` items that are now fulfilled.
|
|
63
|
-
|
|
64
|
-
6. Report completion with the exact string:
|
|
65
|
-
```
|
|
66
|
-
DOCUMENTER_COMPLETE: Updated [comma-separated list of files modified].
|
|
67
|
-
```
|
|
23
|
+
ROLE: update docs+state
|
|
24
|
+
DO:
|
|
25
|
+
- document implemented behavior only
|
|
26
|
+
- update README/api/setup if changed
|
|
27
|
+
- update REQ checks + project reports/state
|
|
28
|
+
OUT: DOCUMENTER_COMPLETE
|