@g3nomaly/g3n-skills 0.1.1 → 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 +96 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# @g3nomaly/g3n-skills
|
|
2
|
+
|
|
3
|
+
The g3n skills for Claude Code and Codex: 28 skills in 8 groups. This package holds the skills and has no CLI. Install them with [`@g3nomaly/skills`](https://www.npmjs.com/package/@g3nomaly/skills), which reads this package as its built-in source, or read it as a Claude Code plugin marketplace.
|
|
4
|
+
|
|
5
|
+
Some skills carry their own hooks. A hook is a TypeScript file in the skill's `hooks/` folder, and the agent runs it with `bun`. The task-manager hooks keep plans, phases and tasks as Markdown files that the agent reaches only through those hooks. The workflow hooks decide when a step of a phase is finished.
|
|
6
|
+
|
|
7
|
+
## Requirements
|
|
8
|
+
|
|
9
|
+
- [Bun](https://bun.sh), to run the hooks
|
|
10
|
+
- A git repository to install into, because `@g3nomaly/skills` anchors a project at its repository root
|
|
11
|
+
- [`@g3nomaly/analyze`](https://www.npmjs.com/package/@g3nomaly/analyze) for the `analyze` skill, which runs `bunx @g3nomaly/analyze`
|
|
12
|
+
|
|
13
|
+
## Install with @g3nomaly/skills
|
|
14
|
+
|
|
15
|
+
Run these from the root of your project:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
bunx @g3nomaly/skills init # pick Claude Code, Codex or both
|
|
19
|
+
bunx @g3nomaly/skills ls --source g3n-skills # lists the skills this package offers
|
|
20
|
+
bunx @g3nomaly/skills add workflow # installs a group, with every skill it depends on
|
|
21
|
+
bunx @g3nomaly/skills add unslop # installs one skill
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
You don't register this package. `g3n-skills` is built into the installer and cannot be removed.
|
|
25
|
+
|
|
26
|
+
Each skill is copied to `.claude/skills/<skill>/`, or `.agents/skills/<skill>/` for Codex, next to the skills it depends on. The installer records it in `.claude/skills.json` or `.agents/skills.json`. Commit the skills and that file if your team should get the same skills.
|
|
27
|
+
|
|
28
|
+
A name that is both a group and a skill, such as `grilling` or `task-manager`, installs the whole group. `add` and `update` also run `bun install` in each skill that ships a `package.json`. Today that is only `task-manager`, which pins zod.
|
|
29
|
+
|
|
30
|
+
```sh
|
|
31
|
+
bunx @g3nomaly/skills update # every installed skill
|
|
32
|
+
bunx @g3nomaly/skills update --dry-run # shows what would change
|
|
33
|
+
bunx @g3nomaly/skills remove grill-me
|
|
34
|
+
bunx @g3nomaly/skills ls --installed
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## As a Claude Code plugin marketplace
|
|
38
|
+
|
|
39
|
+
The package ships `.claude-plugin/marketplace.json`, a marketplace named `g3n` with one plugin per group in the table below.
|
|
40
|
+
|
|
41
|
+
Installed as a plugin, the task-manager group registers two lifecycle hooks. `sync-tree` runs at `SessionStart`, and `guard-tree` runs before `Read`, `Grep` and `Glob`. With `@g3nomaly/skills` you get neither, and the task-manager skill tells the agent to run `sync-tree` itself.
|
|
42
|
+
|
|
43
|
+
There is one known gap. Claude Code caches each plugin in its own folder, so the workflow hooks can't import the task-manager code they need. Install the workflow group with `@g3nomaly/skills` for now.
|
|
44
|
+
|
|
45
|
+
## The skills
|
|
46
|
+
|
|
47
|
+
Skills marked _manual_ run only when you type their command, such as `/grill-me`. The agent loads the others when the task calls for them.
|
|
48
|
+
|
|
49
|
+
| Group | Skill | What it does |
|
|
50
|
+
|---|---|---|
|
|
51
|
+
| `agent` | `bootstrap` | Session start checks (read `CLAUDE.md`, compare the file tree, state the branch) and the agent's boundaries |
|
|
52
|
+
| `agent` | `worktrees` | Work in a git worktree on its home branch and land it with a local squash merge |
|
|
53
|
+
| `coding` | `code` | Rules for writing and checking code, with a toolchain reference per language |
|
|
54
|
+
| `coding` | `document` | Docstrings and comments for functions and classes, and where the reasons behind code go |
|
|
55
|
+
| `coding` | `analyze` | Query a repository's model with `g3n-analyze` and rebuild its documentation site in `analyze_out/` |
|
|
56
|
+
| `grilling` | `grilling` | Interview the user relentlessly to stress-test a plan, decision or idea |
|
|
57
|
+
| `grilling` | `grill-me` | _Manual._ Starts a `/grilling` session |
|
|
58
|
+
| `grilling` | `grill-with-docs` | _Manual._ A grilling session that writes ADRs and a glossary as it goes |
|
|
59
|
+
| `grilling` | `domain-modeling` | Pin down a project's terms and record its architectural decisions |
|
|
60
|
+
| `speech` | `emphasise` | What bold, italics and backticks mean in Markdown that an agent reads |
|
|
61
|
+
| `speech` | `unslop` | Cut AI tells from any writing |
|
|
62
|
+
| `task-manager` | `task-manager` | Query plans, phases and tasks and change their status through hooks |
|
|
63
|
+
| `task-manager` | `vocabulary` | One word per concept, stored in the task-manager tree, so names don't drift between sessions |
|
|
64
|
+
| `task-manager` | `decisions` | Record and look up a plan's decisions as numbered files inside the plan |
|
|
65
|
+
| `using-hooks` | `hook-pre-tool-use` | _Manual._ Writing a `PreToolUse` hook, which can allow, deny or escalate a tool call |
|
|
66
|
+
| `using-hooks` | `hook-post-tool-use` | _Manual._ Writing a `PostToolUse` hook, which reacts to a finished tool call |
|
|
67
|
+
| `using-hooks` | `hook-stop` | _Manual._ Writing a `Stop` hook, which can refuse to let the agent end its turn |
|
|
68
|
+
| `using-hooks` | `hook-user-prompt-submit` | _Manual._ Writing a `UserPromptSubmit` hook, which can add context to a prompt or reject it |
|
|
69
|
+
| `workflow` | `run` | Work one phase through plan, execute, review and sync, one fresh agent per step |
|
|
70
|
+
| `workflow` | `plan` | Turn a phase into task files an agent can execute without asking anything |
|
|
71
|
+
| `workflow` | `execute` | Carry out a phase's tasks, each in its own worktree, and hand each one to review |
|
|
72
|
+
| `workflow` | `review` | Check each in-review task against its requirements, then complete it or send it back |
|
|
73
|
+
| `workflow` | `sync` | Merge a reviewed phase's branches, remove its worktrees, record its decisions and terms, and close it |
|
|
74
|
+
| `workflow` | `orchestrator` | _Manual._ Run a whole plan phase by phase, starting each phase once the phases it depends on are done |
|
|
75
|
+
| `workflow` | `worktree` | Set up, merge and remove the git worktrees tasks are worked in, one per task |
|
|
76
|
+
| `writing` | `writing-great-hooks` | Add, change or debug a hook script or a lifecycle hook |
|
|
77
|
+
| `writing` | `writing-great-skills` | Write or edit a skill, its `SKILL.md`, references and hooks |
|
|
78
|
+
| `writing` | `writing-great-tasks` | Write a task that doesn't leave its executor guessing about scope |
|
|
79
|
+
|
|
80
|
+
The task-manager hooks store the tree in `docs/task-manager` by default. Set `skills.settings.filetreeRoot` in `.g3n.config.json` to move it.
|
|
81
|
+
|
|
82
|
+
## Development
|
|
83
|
+
|
|
84
|
+
Run `bun install` at the repository root first, then every command from this directory.
|
|
85
|
+
|
|
86
|
+
```sh
|
|
87
|
+
bun run build # regenerates .claude-plugin/marketplace.json here and at the repository root
|
|
88
|
+
bun run typecheck
|
|
89
|
+
bun test
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Run `bun run build` after adding a group or a skill, and commit both marketplace files.
|
|
93
|
+
|
|
94
|
+
## License
|
|
95
|
+
|
|
96
|
+
[Elastic License 2.0](https://www.elastic.co/licensing/elastic-license) (`Elastic-2.0`).
|
package/package.json
CHANGED