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
8 changes: 4 additions & 4 deletions .github/workflows/rpgkit-lint.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: RPG-Kit Lint
name: CoderMind Lint

permissions:
contents: read
Expand All @@ -7,13 +7,13 @@ on:
push:
branches: [main]
paths:
- "RPG-Kit/**"
- "CoderMind/**"
- ".github/workflows/rpgkit-*.yml"
- ".github/workflows/scripts/rpgkit/**"
- ".markdownlint-cli2.jsonc"
pull_request:
paths:
- "RPG-Kit/**"
- "CoderMind/**"
- ".github/workflows/rpgkit-*.yml"
- ".github/workflows/scripts/rpgkit/**"
- ".markdownlint-cli2.jsonc"
Expand All @@ -30,4 +30,4 @@ jobs:
uses: DavidAnson/markdownlint-cli2-action@v19
with:
globs: |
RPG-Kit/**/*.md
CoderMind/**/*.md
8 changes: 4 additions & 4 deletions .github/workflows/rpgkit-pre-release.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: RPG-Kit Pre-Release
name: CoderMind Pre-Release

on:
push:
branches:
- dev
paths:
- "RPG-Kit/**"
- "CoderMind/**"
- ".github/workflows/rpgkit-pre-release.yml"
- ".github/workflows/scripts/rpgkit/**"
workflow_dispatch:
Expand All @@ -17,7 +17,7 @@ jobs:
contents: write
pull-requests: write
env:
PROJECT_DIR: RPG-Kit
PROJECT_DIR: CoderMind
steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand All @@ -28,7 +28,7 @@ jobs:
- name: Prepare scripts
run: chmod +x .github/workflows/scripts/rpgkit/*.sh

- name: Get RPG-Kit pre-release version
- name: Get CoderMind pre-release version
id: get_tag
run: .github/workflows/scripts/rpgkit/get-next-pre-version.sh "${{ github.run_number }}"

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/rpgkit-release.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: RPG-Kit Release
name: CoderMind Release

on:
push:
branches: [main]
paths:
- "RPG-Kit/**"
- "CoderMind/**"
- ".github/workflows/rpgkit-release.yml"
- ".github/workflows/scripts/rpgkit/**"
workflow_dispatch:
Expand All @@ -16,7 +16,7 @@ jobs:
contents: write
pull-requests: write
env:
PROJECT_DIR: RPG-Kit
PROJECT_DIR: CoderMind
steps:
- name: Checkout repository
uses: actions/checkout@v4
Expand All @@ -27,7 +27,7 @@ jobs:
- name: Prepare scripts
run: chmod +x .github/workflows/scripts/rpgkit/*.sh

- name: Get next RPG-Kit version
- name: Get next CoderMind version
id: get_tag
run: .github/workflows/scripts/rpgkit/get-next-version.sh

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
37 changes: 20 additions & 17 deletions RPG-Kit/README.md → CoderMind/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1 align="center">RPG-Kit</h1>
<h1 align="center">CoderMind <sup><sub>(formerly RPG-Kit)</sub></sup></h1>

<p align="center">
<a href="README.md">English</a> |
Expand All @@ -8,13 +8,16 @@
<a href="README.hi-IN.md">हिन्दी</a>
</p>

> [!NOTE]
> **CoderMind** is the new name for **RPG-Kit**. The product has been renamed; the install command (`rpgkit`) and package (`rpgkit-cli`) will be renamed in a subsequent release.

## Make coding agents plan before they edit

Coding agents are strong at local edits, but repo-level tasks often fail without a stable planning structure. Requirements drift, architecture decisions disappear, multi-file generation becomes inconsistent, and updates can miss hidden dependencies.

RPG-Kit gives Claude Code and GitHub Copilot a **persistent RPG workspace** for repository-level coding. The workspace is built around a Repository Planning Graph (RPG) that connects requirements, features, architecture, files, code entities, and dependencies.
CoderMind gives Claude Code and GitHub Copilot a **persistent RPG workspace** for repository-level coding. The workspace is built around a Repository Planning Graph (RPG) that connects requirements, features, architecture, files, code entities, and dependencies.

With RPG-Kit, agents work through graph-driven workflows:
With CoderMind, agents work through graph-driven workflows:

- **Build**: turn requirements into an RPG plan, then generate a multi-file repository.
- **Understand**: map an existing repo into RPG, then search, explore, and explain it.
Expand Down Expand Up @@ -77,11 +80,11 @@ MCP Server: search_rpg / explore_rpg / get_node_detail / list_rpg_tree

</details>

### RPG-Kit in action
### CoderMind in action

Below is part of the graph visualization generated for this repository. After running `/rpgkit.encode`, you can open `<workspace>/.rpgkit/reports/rpg.html` to browse the full interactive graph. Run `rpgkit version` to see the resolved paths for the current workspace.

![RPG-Kit repository graph visualization](../docs/rpgkit_visualized_graph.png)
![CoderMind repository graph visualization](../docs/rpgkit_visualized_graph.png)

## Installation

Expand All @@ -92,22 +95,22 @@ Below is part of the graph visualization generated for this repository. After ru
- Git
- An installed and authenticated AI coding agent CLI: [GitHub Copilot](https://docs.github.com/en/copilot) or [Claude Code](https://docs.anthropic.com/en/docs/claude-code/setup)

### Install RPG-Kit
### Install CoderMind

```bash
# For persistent installation (Recommended)
uv tool install rpgkit-cli --from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=RPG-Kit"
uv tool install rpgkit-cli --from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=CoderMind"
rpgkit check

# For one-time usage
uvx --from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=RPG-Kit" rpgkit init <project-name>
uvx --from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=CoderMind" rpgkit init <project-name>
```

Since `0.1.3`, the wheel ships the pipeline scripts and slash-command templates as packaged assets, so `rpgkit init` works offline (for example in air-gapped or corporate proxy environments).

## Quick Start: New Repository

Use this path when you want RPG-Kit to turn requirements into a new codebase.
Use this path when you want CoderMind to turn requirements into a new codebase.

> [!WARNING]
> For projects with a large amount of generated code, `/rpgkit.design_interfaces` and `/rpgkit.code_gen` can take a long time to run. As a typical example: 100 features take about 30 minutes.
Expand Down Expand Up @@ -152,7 +155,7 @@ Use this path when you want RPG-Kit to turn requirements into a new codebase.
> - **Claude Code**: type `/rpgkit.feature_spec ...` directly in the chat — slash commands are recognised and dispatch the matching workflow.
> - **GitHub Copilot CLI**: slash commands are not supported (custom agents are), so first run `/agent rpgkit.feature_spec` to switch to the target agent, then type `start` to run its built-in workflow.

RPG-Kit progressively builds `rpg.json` in the home-side runtime directory (`~/.rpgkit/workspaces/<workspace-id>/data/rpg.json`) and uses it to keep requirements, planning artifacts, generated code, and dependency information aligned. Your workspace source files are not polluted.
CoderMind progressively builds `rpg.json` in the home-side runtime directory (`~/.rpgkit/workspaces/<workspace-id>/data/rpg.json`) and uses it to keep requirements, planning artifacts, generated code, and dependency information aligned. Your workspace source files are not polluted.

## Quick Start: Existing Repository

Expand All @@ -161,7 +164,7 @@ Use this path when you already have a repository and want an AI agent to underst
> [!WARNING]
> For larger projects, `rpgkit init . --encode` and `/rpgkit.encode` can take a long time to run. As a typical example: 200 source files take about 100 minutes.

1. Initialize RPG-Kit in the repository root and build the initial graph:
1. Initialize CoderMind in the repository root and build the initial graph:

```bash
cd existing-repo/
Expand All @@ -184,11 +187,11 @@ Use this path when you already have a repository and want an AI agent to underst
/rpgkit.rpg_edit <edit instructions> # graph-aware code edit
```

4. After each commit, the git hook installed by RPG-Kit automatically calls the `rpgkit hook <name>` dispatcher to update the RPG and keep it aligned with code changes. If the hook fails or is skipped, run `/rpgkit.update_rpg` manually.
4. After each commit, the git hook installed by CoderMind automatically calls the `rpgkit hook <name>` dispatcher to update the RPG and keep it aligned with code changes. If the hook fails or is skipped, run `/rpgkit.update_rpg` manually.

## What happens after `rpgkit init`

`rpgkit init` does not modify your source files, **and it does not write runtime state into your workspace**. It only adds command definitions, MCP configuration, and hooks to your workspace. RPG-Kit runtime data (artifacts and logs) lives under the home-side directory `~/.rpgkit/workspaces/<workspace-id>/`, where `<workspace-id>` is a slug derived from the workspace's absolute path (e.g. `home-hys-projects-myrepo`).
`rpgkit init` does not modify your source files, **and it does not write runtime state into your workspace**. It only adds command definitions, MCP configuration, and hooks to your workspace. CoderMind runtime data (artifacts and logs) lives under the home-side directory `~/.rpgkit/workspaces/<workspace-id>/`, where `<workspace-id>` is a slug derived from the workspace's absolute path (e.g. `home-hys-projects-myrepo`).

```text
my-project/
Expand All @@ -201,11 +204,11 @@ my-project/

See [docs/project-structure.md](docs/project-structure.md) for the full layout and data file reference.

## Updating RPG-Kit
## Updating CoderMind

```bash
uv tool install rpgkit-cli \
--from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=RPG-Kit" \
--from "git+https://github.com/microsoft/RPG-ZeroRepo.git#subdirectory=CoderMind" \
--force \
--reinstall

Expand Down Expand Up @@ -237,13 +240,13 @@ rpgkit update
- [Slash command reference](docs/commands.md) — every `/rpgkit.*` command, inputs, outputs, and examples.
- [CLI reference](docs/cli-reference.md) — `rpgkit init`, `rpgkit update`, `rpgkit check`, `rpgkit version`, and all options.
- [Configuration](docs/configuration.md) — AI assistant setup, MCP registration, hooks, auto-approval, and troubleshooting.
- [Project structure](docs/project-structure.md) — files and directories created by RPG-Kit.
- [Project structure](docs/project-structure.md) — files and directories created by CoderMind.

## Upcoming Features

- **Simpler generation commands:** merge the current multi-step generation flow into fewer commands, such as `/rpgkit.generate_repo`, `/rpgkit.generate_feature`, and `/rpgkit.plan`.
- **Multi-language support:** add support for Go, C++, Rust, JavaScript/TypeScript, and more.
- **More platform integrations:** support RPG-Kit across CLI and VS Code extension workflows for different AI coding agents on different systems.
- **More platform integrations:** support CoderMind across CLI and VS Code extension workflows for different AI coding agents on different systems.

## Troubleshooting

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading
Loading