Skip to content
Open
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
31 changes: 23 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# GET SHIT DONE

**A light-weight and powerful meta-prompting, context engineering and spec-driven development system for Claude Code, OpenCode, Gemini CLI, and Codex.**
**A light-weight and powerful meta-prompting, context engineering and spec-driven development system for Claude Code, OpenCode, Gemini CLI, Codex, and Kimi.**

**Solves context rot — the quality degradation that happens as Claude fills its context window.**

Expand Down Expand Up @@ -80,16 +80,17 @@ npx get-shit-done-cc@latest
```

The installer prompts you to choose:
1. **Runtime** — Claude Code, OpenCode, Gemini, Codex, or all
1. **Runtime** — Claude Code, OpenCode, Gemini, Codex, Kimi, or all
2. **Location** — Global (all projects) or local (current project only)

Verify with:
- Claude Code / Gemini: `/gsd:help`
- OpenCode: `/gsd-help`
- Codex: `$gsd-help`
- Kimi: `/skill:gsd-help`

> [!NOTE]
> Codex installation uses skills (`skills/gsd-*/SKILL.md`) rather than custom prompts.
> Codex and Kimi installations use skills (`skills/gsd-*/SKILL.md`) rather than custom prompts.

### Staying Updated

Expand Down Expand Up @@ -117,12 +118,15 @@ npx get-shit-done-cc --gemini --global # Install to ~/.gemini/
npx get-shit-done-cc --codex --global # Install to ~/.codex/
npx get-shit-done-cc --codex --local # Install to ./.codex/

# Kimi (skills-first)
npx get-shit-done-cc --kimi --global # Install skills to ~/.config/agents/skills/

# All runtimes
npx get-shit-done-cc --all --global # Install to all directories
```

Use `--global` (`-g`) or `--local` (`-l`) to skip the location prompt.
Use `--claude`, `--opencode`, `--gemini`, `--codex`, or `--all` to skip the runtime prompt.
Use `--claude`, `--opencode`, `--gemini`, `--codex`, `--kimi`, or `--all` to skip the runtime prompt.

</details>

Expand Down Expand Up @@ -521,6 +525,12 @@ You're never locked in. The system adapts.

<sup>¹ Contributed by reddit user OracleGreyBeard</sup>

> **Command syntax by terminal:**
> - Claude Code / Gemini: `/gsd:<command>` (e.g., `/gsd:new-project`)
> - OpenCode: `/gsd-<command>` (e.g., `/gsd-new-project`)
> - Codex: `$gsd-<command>` (e.g., `$gsd-new-project`)
> - Kimi: `/skill:gsd-<command>` (e.g., `/skill:gsd-new-project`)

---

## Configuration
Expand Down Expand Up @@ -628,10 +638,11 @@ This prevents Claude from reading these files entirely, regardless of what comma
**Commands not found after install?**
- Restart your runtime to reload commands/skills
- Verify files exist in `~/.claude/commands/gsd/` (global) or `./.claude/commands/gsd/` (local)
- For Codex, verify skills exist in `~/.codex/skills/gsd-*/SKILL.md` (global) or `./.codex/skills/gsd-*/SKILL.md` (local)
- For Codex, verify skills exist in `~/.codex/skills/gsd-*/SKILL.md`
- For Kimi, verify skills exist in `~/.config/agents/skills/gsd-*/SKILL.md`

**Commands not working as expected?**
- Run `/gsd:help` to verify installation
- Run `/gsd:help` (or `/skill:gsd-help` for Kimi) to verify installation
- Re-run `npx get-shit-done-cc` to reinstall

**Updating to the latest version?**
Expand All @@ -641,9 +652,13 @@ npx get-shit-done-cc@latest

**Using Docker or containerized environments?**

If file reads fail with tilde paths (`~/.claude/...`), set `CLAUDE_CONFIG_DIR` before installing:
If file reads fail with tilde paths (`~/.claude/...`), set the appropriate config dir environment variable before installing:
```bash
CLAUDE_CONFIG_DIR=/home/youruser/.claude npx get-shit-done-cc --global
# Claude Code
CLAUDE_CONFIG_DIR=/home/youruser/.claude npx get-shit-done-cc --claude --global

# Kimi
KIMI_CONFIG_DIR=/home/youruser/.kimi npx get-shit-done-cc --kimi --global
```
This ensures absolute paths are used instead of `~` which may not expand correctly in containers.

Expand Down
Loading