Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ claude --plugin-dir /path/to/groundwork

## How the repo is laid out

- `.claude-plugin/plugin.json` (Claude Code) and `plugin.json` (the portable manifest Codex reads, with its
`extensions.com.openai` display fields): keep their shared fields identical (a test checks it). Claude Code
lists the skills; Codex finds them in `skills/`.
- `skills/<skill>/SKILL.md`: one per skill, short. Each reads the shared files it needs from `references/`.
- `references/`: the rules every skill shares. `structure.md` (the planning tree), `grilling.md` (how questions are
asked), `approval.md` (what needs a yes), `drafting.md` (the create flow), `trackers/` (one guide per tracker).
Expand All @@ -44,4 +47,4 @@ A rule belongs in one place. If two skills need it, it goes in `references/` and

`main` is protected: work on a branch named after the issue (`<n>-short-name`) and open a pull request whose title is
a conventional commit (`feat(shape): …`, `fix(init): …`) with `Fixes #<n>` in the body. release-please builds the
version and the changelog from those titles; don't edit `VERSION` or `plugin.json`'s version by hand.
version and the changelog from those titles; don't edit `VERSION` or either manifest's version by hand.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# groundwork

**Plan work before building it.** groundwork is a Claude Code plugin that turns an idea into epics, stories and
**Plan work before building it.** groundwork is a plugin for Claude Code and Codex that turns an idea into epics, stories and
tickets through short grilling sessions, keeps every decision in a folder tree next to your code, drafts the tracker
issues, plans each ticket against the code as it is that day, and builds it. It asks before every write outside the
planning folder.

**New here?** Read the [usage guide](docs/usage.md): install, setup, and a walk from idea to merged pull request.

```
/groundwork:shape "the checkout feels slow and nobody knows why" → a story, split in three tickets
/groundwork:create-story grill the design → decisions/ → draft the story and its tickets → create the issues
Expand All @@ -29,22 +31,39 @@ session, and asked again by the next ticket. groundwork makes them explicit:

## Install

groundwork is published in the [codeonym-oss marketplace](https://github.com/codeonym-oss/claude-plugins).

**Claude Code:**

```
/plugin marketplace add codeonym-oss/claude-plugins
/plugin install groundwork@codeonym-oss
```

**Codex** (a Codex CLI that supports `codex plugin`), in your terminal:

```bash
codex plugin marketplace add codeonym-oss/claude-plugins
codex plugin add groundwork@codeonym-oss
```

Then start a new Codex session. If you added the marketplace before it supported Codex, refresh it first with
`codex plugin marketplace upgrade codeonym-oss`.

Then, in your project:

```
/groundwork:init
```

In Codex, which has no `/groundwork:…` commands, find the skills with `/skills` or ask for one by name ("use
groundwork's init skill"). See [Using groundwork in Codex](docs/usage.md#using-groundwork-in-codex).

`init` checks your tools, detects the forge (`gh` or `glab`), asks which tracker you use and your project's own
rules (what a story point means, the language of issue titles…), writes them to `groundwork.md`, offers to add
[Andrej Karpathy's coding guidelines](https://github.com/multica-ai/andrej-karpathy-skills) to `AGENTS.md` and
`CLAUDE.md`, and offers to install [Matt Pocock's skills](https://github.com/mattpocock/skills) that
`implement` builds with. Every step asks first.
`implement` builds with. Every step asks first. The [usage guide](docs/usage.md#set-up-a-project) goes through each step.

## Skills

Expand Down Expand Up @@ -95,17 +114,18 @@ linked, moved and closed, so a write to your shared board is never improvised. A

## Works with any coding agent

groundwork is built and tested as a Claude Code plugin. But its skills are plain `SKILL.md` files and its planning
tree is plain Markdown, so any agent can follow the same workflow:
groundwork installs as a plugin in **Claude Code** and **Codex** (see [Install](#install)). Its skills are plain
`SKILL.md` files and its planning tree is plain Markdown, so other agents can follow the same workflow too:

- **Agents that load skills** (Codex, Cursor, Gemini CLI and others): point them at this repo's `skills/` folder;
each skill reads the shared `references/` through relative paths.
- **Agents that load skills** (Cursor, Gemini CLI and others): point them at this repo's `skills/` folder; each
skill reads the shared `references/` through relative paths.
- **Any agent at all:** the planning tree is just files. An agent that reads `groundwork.md`,
`references/structure.md` and a level's `decisions/` can plan and build within the same rules.
- `init` writes the coding guidelines into `AGENTS.md`, which Codex, Cursor and Gemini CLI read, and points
`CLAUDE.md` at it.

Only Claude Code is tested today. Reports from other agents are welcome.
groundwork is built and tested in Claude Code. Its Codex install has been checked; reports on how the workflow
behaves in Codex and other agents are welcome.

## How it differs from Matt Pocock's skills

Expand Down
Loading
Loading