agentbrief 0.1.0 → 0.1.2
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 +79 -32
- package/briefs/base-agent/brief.yaml +6 -0
- package/briefs/base-agent/personality.md +9 -0
- package/briefs/base-agent/skills/agent-browser/SKILL.md +682 -0
- package/briefs/code-reviewer/brief.yaml +2 -0
- package/briefs/data-analyst/brief.yaml +2 -0
- package/briefs/devops-sre/brief.yaml +2 -0
- package/briefs/frontend-design/brief.yaml +2 -0
- package/briefs/fullstack-dev/brief.yaml +1 -0
- package/briefs/growth-engineer/brief.yaml +2 -0
- package/briefs/nextjs-fullstack/brief.yaml +2 -0
- package/briefs/product-manager/brief.yaml +2 -0
- package/briefs/qa-engineer/brief.yaml +2 -0
- package/briefs/security-auditor/brief.yaml +2 -0
- package/briefs/startup-builder/brief.yaml +2 -0
- package/briefs/startup-kit/brief.yaml +1 -0
- package/briefs/tech-writer/brief.yaml +2 -0
- package/briefs/typescript-strict/brief.yaml +2 -0
- package/dist/cli.js +28 -5
- package/dist/cli.js.map +1 -1
- package/dist/compiler.d.ts.map +1 -1
- package/dist/compiler.js +4 -1
- package/dist/compiler.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +24 -10
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/registry.yaml +7 -0
package/README.md
CHANGED
|
@@ -11,20 +11,47 @@
|
|
|
11
11
|
One command turns your Claude Code / Cursor / OpenCode / Codex from a generic assistant into a specialized professional.
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
npx agentbrief use
|
|
15
|
-
# Your
|
|
14
|
+
npx agentbrief use fullstack-dev
|
|
15
|
+
# Your agent now enforces strict TypeScript, follows Next.js conventions,
|
|
16
|
+
# builds accessible UIs, and reviews PRs like a staff engineer — 8 skills in 1 command
|
|
16
17
|
```
|
|
17
18
|
|
|
18
19
|
## What It Does
|
|
19
20
|
|
|
20
|
-
AgentBrief compiles a **brief** (role definition + domain knowledge +
|
|
21
|
+
AgentBrief compiles a **brief** (role definition + domain knowledge + executable skills) into the instruction files your AI agent reads — `CLAUDE.md`, `.cursorrules`, `AGENTS.md` — with content automatically adapted for each engine.
|
|
21
22
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
23
|
+
<details>
|
|
24
|
+
<summary><b>See it in action</b> — what happens when you run <code>agentbrief use fullstack-dev</code></summary>
|
|
25
|
+
|
|
26
|
+
Your `CLAUDE.md` gets this injected (existing content preserved):
|
|
27
|
+
|
|
28
|
+
```markdown
|
|
29
|
+
<!-- agentbrief:fullstack-dev:start -->
|
|
30
|
+
# AgentBrief: fullstack-dev
|
|
31
|
+
|
|
32
|
+
## Role
|
|
33
|
+
You are a senior full-stack TypeScript developer. You build production
|
|
34
|
+
applications with Next.js 15, React 19, and Tailwind CSS. You enforce
|
|
35
|
+
strict type safety and review your own code with principal-engineer rigor.
|
|
36
|
+
|
|
37
|
+
## Constraints
|
|
38
|
+
- Never use `any` — always annotate return types on exports
|
|
39
|
+
- Server Components by default — only add 'use client' when needed
|
|
40
|
+
- WCAG 2.1 AA minimum — semantic HTML, keyboard navigation
|
|
41
|
+
|
|
42
|
+
## Skills
|
|
43
|
+
- **next-best-practices** — USE WHEN: Writing Next.js code
|
|
44
|
+
- **typescript-advanced-types** — USE WHEN: Complex type logic
|
|
45
|
+
- **architecture-review** — USE WHEN: Reviewing PRs
|
|
46
|
+
- **design-review-checklist** — USE WHEN: Checking UI quality
|
|
47
|
+
- **agent-browser** — USE WHEN: Visual verification needed
|
|
48
|
+
...and 4 more
|
|
49
|
+
<!-- agentbrief:fullstack-dev:end -->
|
|
26
50
|
```
|
|
27
51
|
|
|
52
|
+
Cleanly removable with `agentbrief eject fullstack-dev`.
|
|
53
|
+
</details>
|
|
54
|
+
|
|
28
55
|
- **One command to apply, one to remove** — `use` and `eject`
|
|
29
56
|
- **Non-invasive** — injected content is wrapped in markers, your existing files are untouched
|
|
30
57
|
- **Stackable** — apply multiple briefs; later ones layer on top
|
|
@@ -70,33 +97,36 @@ agentbrief init my-agent --template security
|
|
|
70
97
|
|
|
71
98
|
## Official Registry
|
|
72
99
|
|
|
73
|
-
|
|
74
|
-
agentbrief search
|
|
75
|
-
```
|
|
100
|
+
**⚡ Quick Start Packs** — best if you're not sure where to begin:
|
|
76
101
|
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
startup-kit official Startup builder kit — extends 4 briefs, 9 skills
|
|
95
|
-
```
|
|
102
|
+
| Pack | What your agent gains |
|
|
103
|
+
|------|----------------------|
|
|
104
|
+
| `fullstack-dev` | Strict TypeScript + Next.js conventions + accessible UI + PR reviews (9 skills) |
|
|
105
|
+
| `startup-kit` | Product specs + SEO audit + growth analytics + security review + launch strategy (12 skills) |
|
|
106
|
+
|
|
107
|
+
**Code Quality & Engineering:**
|
|
108
|
+
|
|
109
|
+
| Brief | Your agent becomes... |
|
|
110
|
+
|-------|----------------------|
|
|
111
|
+
| `security-auditor` | OWASP security reviewer who cites CWE numbers |
|
|
112
|
+
| `code-reviewer` | Staff engineer who catches architecture + logic issues |
|
|
113
|
+
| `qa-engineer` | QA who finds bugs, writes tests, fixes with atomic commits |
|
|
114
|
+
| `typescript-strict` | Type safety enforcer — zero `any`, exhaustive checks |
|
|
115
|
+
| `nextjs-fullstack` | Next.js 15 specialist (App Router, RSC, Tailwind) |
|
|
116
|
+
| `frontend-design` | Design engineer with 80-item review checklist |
|
|
117
|
+
| `devops-sre` | SRE who sets up CI/CD, monitoring, incident response |
|
|
118
|
+
| `tech-writer` | Documentation specialist with API docs + release notes |
|
|
96
119
|
|
|
97
|
-
|
|
120
|
+
**Product, Growth & Business:**
|
|
98
121
|
|
|
99
|
-
|
|
122
|
+
| Brief | Your agent becomes... |
|
|
123
|
+
|-------|----------------------|
|
|
124
|
+
| `product-manager` | PM who writes PRDs with RICE/ICE prioritization |
|
|
125
|
+
| `growth-engineer` | Growth hacker with SEO audit + analytics + content strategy |
|
|
126
|
+
| `data-analyst` | BI analyst with metrics frameworks + SQL patterns |
|
|
127
|
+
| `startup-builder` | Startup advisor with CEO review + launch planning |
|
|
128
|
+
|
|
129
|
+
Browse the **[full Catalog](./CATALOG.md)** or the **[Website](https://0xranx.github.io/agentbrief)** to see details for each brief.
|
|
100
130
|
|
|
101
131
|
## What's a Brief?
|
|
102
132
|
|
|
@@ -114,7 +144,19 @@ my-brief/
|
|
|
114
144
|
└── ... # any supporting files
|
|
115
145
|
```
|
|
116
146
|
|
|
117
|
-
See `examples/security-auditor/` for a complete example.
|
|
147
|
+
See `examples/security-auditor/` for a complete example.
|
|
148
|
+
|
|
149
|
+
## Create & Publish Your Own
|
|
150
|
+
|
|
151
|
+
Share your expertise as a reusable brief:
|
|
152
|
+
|
|
153
|
+
1. **Scaffold** — `agentbrief init my-agent` (or `--template security`)
|
|
154
|
+
2. **Customize** — Edit `personality.md`, add `knowledge/` and `skills/`
|
|
155
|
+
3. **Test** — `agentbrief use ./my-agent` in a temp directory
|
|
156
|
+
4. **Preview** — `agentbrief preview ./my-agent` to see compiled output
|
|
157
|
+
5. **Publish** — Push to GitHub → `agentbrief use github:you/my-agent`
|
|
158
|
+
|
|
159
|
+
Want it in the official registry? [Submit a PR](./CONTRIBUTING.md). Read the full **[Authoring Guide](https://0xranx.github.io/agentbrief/docs.html#AUTHORING)**.
|
|
118
160
|
|
|
119
161
|
## Supported Engines
|
|
120
162
|
|
|
@@ -136,6 +178,11 @@ AgentBrief compiles each brief with optimizations for the target engine:
|
|
|
136
178
|
|
|
137
179
|
Commit the engine instruction files (`CLAUDE.md`, `.cursorrules`, `AGENTS.md`) so your team shares the same agent behavior.
|
|
138
180
|
|
|
181
|
+
## Community
|
|
182
|
+
|
|
183
|
+
- [GitHub Discussions](https://github.com/0xranx/agentbrief/discussions) — Questions, showcase your briefs, feature ideas
|
|
184
|
+
- [Contributing Guide](./CONTRIBUTING.md) — How to submit briefs to the registry
|
|
185
|
+
|
|
139
186
|
## License
|
|
140
187
|
|
|
141
188
|
[MIT](./LICENSE)
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
## Role
|
|
2
|
+
|
|
3
|
+
You are an AI coding agent with foundational capabilities for browsing, inspecting, and interacting with web applications and services.
|
|
4
|
+
|
|
5
|
+
## Constraints
|
|
6
|
+
|
|
7
|
+
- Always use agent-browser for visual verification before claiming UI work is complete
|
|
8
|
+
- Take screenshots to document visual state when reporting issues
|
|
9
|
+
- Use snapshots (accessibility tree) instead of raw DOM for element interaction
|