repo-agent-brief 0.2.0 → 0.2.1
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 +4 -0
- package/package.json +3 -2
- package/skills/repo-agent-brief/SKILL.md +53 -0
package/README.md
CHANGED
|
@@ -87,3 +87,7 @@ This is not a full secret scanner. It catches common token/private-key/secret-as
|
|
|
87
87
|
## License
|
|
88
88
|
|
|
89
89
|
MIT
|
|
90
|
+
|
|
91
|
+
## Agent Skill
|
|
92
|
+
|
|
93
|
+
This package includes an OpenClaw/Claude-style skill at `skills/repo-agent-brief` that teaches agents to run repo preflight and diff-aware handoff briefs before editing or reviewing code.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "repo-agent-brief",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Generate concise, safety-aware project briefs for coding agents.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -12,7 +12,8 @@
|
|
|
12
12
|
"files": [
|
|
13
13
|
"src",
|
|
14
14
|
"README.md",
|
|
15
|
-
"LICENSE"
|
|
15
|
+
"LICENSE",
|
|
16
|
+
"skills/"
|
|
16
17
|
],
|
|
17
18
|
"scripts": {
|
|
18
19
|
"test": "node --test",
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: repo-agent-brief
|
|
3
|
+
description: Generate concise, safety-aware repository orientation briefs with repo-agent-brief/agent-brief before coding-agent work, reviews, handoffs, PR analysis, unfamiliar repo edits, diff-aware branch handoffs, or when an agent needs stack/commands/context/risk signals before changing files.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Repo Agent Brief Skill
|
|
7
|
+
|
|
8
|
+
Use `repo-agent-brief` to orient an agent before it edits or reviews a repository. It finds high-signal context files, infers stack/commands, builds a compact repo map, and flags obvious secret/risky-instruction patterns.
|
|
9
|
+
|
|
10
|
+
## Default workflow
|
|
11
|
+
|
|
12
|
+
From the repository root:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npx repo-agent-brief . > AGENT_BRIEF.md
|
|
16
|
+
sed -n '1,220p' AGENT_BRIEF.md
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
For in-progress branches:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx repo-agent-brief . --diff origin/main > AGENT_HANDOFF.md
|
|
23
|
+
sed -n '1,260p' AGENT_HANDOFF.md
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
For machine-readable automation:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx repo-agent-brief . --format json > agent-brief.json
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## When to use
|
|
33
|
+
|
|
34
|
+
- First pass in an unfamiliar repo.
|
|
35
|
+
- Before delegating to a coding agent.
|
|
36
|
+
- PR/branch handoff where changed files matter.
|
|
37
|
+
- Safety preflight before touching CI, migrations, deploy scripts, auth, or config.
|
|
38
|
+
|
|
39
|
+
## Safety
|
|
40
|
+
|
|
41
|
+
- This is not a full secret scanner. Use Gitleaks/TruffleHog for full audits.
|
|
42
|
+
- If high-risk patterns are found, inspect before proceeding.
|
|
43
|
+
- Use `--fail-on-high-risk` in CI or strict agent workflows.
|
|
44
|
+
- Generated briefs may include snippets from repo context files; avoid posting publicly without review.
|
|
45
|
+
|
|
46
|
+
## Useful commands
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npx repo-agent-brief .
|
|
50
|
+
npx repo-agent-brief . --diff HEAD
|
|
51
|
+
npx repo-agent-brief . --diff origin/main --fail-on-high-risk
|
|
52
|
+
npx repo-agent-brief . --no-snippets
|
|
53
|
+
```
|