open/graceful-handoff
1
0
Fork 0
Code Issues Releases Activity

docs(graceful-handoff): bring README in line with the org repo standard

Browse source 
Ran the repo-standard gate (plugin class): 5 ERROR + 2 WARN + 2 SKIP.
Now 0 ERROR / 0 WARN / 0 SKIP, 13 checks passing. Docs only — no plugin
code, version or behaviour changed.

- H1 is the repo name; opening line is verbatim the forge description, so
  description == catalog == README is machine-checkable.
- `## Install` promoted to a top-level heading on the first screen and given
  the CLI command `claude plugin install graceful-handoff@ktg-plugin-marketplace`
  next to `marketplace add` (the enabledPlugins JSON stays as a second form).
  Prerequisites split out as `## Requirements`; Quick Start keeps the usage.
- Added `## Non-goals` (what it deliberately does not do) and `## Changelog`.
- Dropped the static tests-30 badge: no CI runner exists on this forge, so it
  asserted a run nothing verifies. The Testing section now states the command
  and that nothing runs it automatically.
- Fixed two dead `../../README.md` references inherited from the monorepo —
  both point outside a standalone repo and 404.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019x1C8tjmB2vUCM9jE668ZF
This commit is contained in:
Kjell Tore Guttormsen 2026-08-03 21:53:11 +02:00
commit 13e29723a7
2 changed files with 60 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CHANGELOG.md
View file

@ -4,6 +4,14 @@ All notable changes to graceful-handoff are documented here.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
## [Unreleased]
### Changed
- **README brought in line with the org repo standard** (`repo-standard` gate, 0 ERROR). Documentation only — no plugin code, version, or behaviour changed. H1 is now the repo name; the opening line is verbatim the forge description (so description == catalog == README is machine-checkable); `## Install` is a top-level heading on the first screen and carries the CLI command `claude plugin install graceful-handoff@ktg-plugin-marketplace` next to `marketplace add`; `## Non-goals` and `## Changelog` sections added.
- **Dropped the static `tests-30` badge.** This forge has no CI runner, so the badge asserted a run nothing verifies. The Testing section now states the command and says plainly that nothing runs it automatically. Note for the catalog: the tests axis no longer has a badge backing it.
- **Fixed two dead `../../README.md` references** inherited from the monorepo (README lines 7 and the marketplace footer) — both pointed outside a standalone repo and 404'd.
## [3.1.0] - 2026-06-24
### Changed

83
README.md
View file

@ -1,26 +1,51 @@
# Graceful Handoff Plugin for Claude Code
# graceful-handoff
> One command to end a session cleanly and hand it to the next one — `/graceful-handoff` reaches a natural stopping point and overwrites the nearest `STATE.md` with a complete, self-standing state-of-play.
One-command session handoff into the STATE.md continuity system. Overwrites the nearest STATE.md with a complete state-of-play and commits per remote policy.
> **Solo-maintained, fork-and-own.** This plugin is a starting point, not a vendor product. Issues are welcome as signals; pull requests are not accepted. See [GOVERNANCE.md](GOVERNANCE.md) for the full model and what upstream provides.
*AI-generated: all code produced by Claude Code through dialog-driven development. [Full disclosure →](../../README.md#ai-generated-code-disclosure)*
*AI-generated: all code produced by Claude Code through dialog-driven development. Every change is human-directed, reviewed, and validated before commit.*
![Version](https://img.shields.io/badge/version-3.1.0-blue)
![Platform](https://img.shields.io/badge/platform-Claude_Code_Plugin-purple)
![Skill](https://img.shields.io/badge/skill-1-green)
![Hooks](https://img.shields.io/badge/hooks-0-lightgrey)
![Pipeline](https://img.shields.io/badge/STATE--helper-deterministic-cyan)
![Tests](https://img.shields.io/badge/tests-30-success)
![License](https://img.shields.io/badge/license-MIT-lightgrey)
A Claude Code plugin that makes session handoff a single deliberate command, fully integrated with a `STATE.md`-based continuity system. When a session is filling up — or you simply want to stop — `/graceful-handoff` reaches a natural stopping point, **overwrites the nearest `STATE.md`** with where you are, the next concrete step, and what to read, then commits per your remote policy. The next session reads that `STATE.md` and stands on its own.
---
## Install
```bash
claude plugin marketplace add https://git.fromaitochitta.com/open/ktg-plugin-marketplace.git
claude plugin install graceful-handoff@ktg-plugin-marketplace
```
Or enable directly in `~/.claude/settings.json`:
```json
{
"enabledPlugins": {
"graceful-handoff@ktg-plugin-marketplace": true
}
}
```
## Requirements
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) v2.x+
- Node.js (any recent LTS — for the helper script)
- A git repository (the helper detects detached HEAD / missing upstream and reports gracefully)
---
## Table of Contents
- [What Is This?](#what-is-this)
- [Non-goals](#non-goals)
- [The Problem](#the-problem)
- [The STATE.md Model](#the-statemd-model)
- [Quick Start](#quick-start)
@ -33,6 +58,7 @@ A Claude Code plugin that makes session handoff a single deliberate command, ful
- [Testing](#testing)
- [What Changed in v3.0 (BREAKING)](#what-changed-in-v30-breaking)
- [Limitations & Open Assumptions](#limitations--open-assumptions)
- [Changelog](#changelog)
- [License](#license)
- [Feedback & Contributing](#feedback--contributing)
@ -53,6 +79,19 @@ The skill is `disable-model-invocation: true`: the model cannot trigger a handof
---
## Non-goals
What this plugin deliberately does *not* do — read this before adopting it:
- **It never triggers itself.** No hooks, no Stop auto-trigger, no context-percentage threshold. If you want a handoff written automatically when a session fills up, this is the wrong plugin — v2 did that and v3 removed it on purpose.
- **It does not read `STATE.md` back.** Injecting the nearest `STATE.md` at session start is the job of a global `session-start.sh` hook you own. This plugin only writes.
- **It does not push.** The helper has no push path at all; pushing stays a separate, user-triggered step.
- **It is not a general-purpose commit tool.** `--commit` stages `STATE.md` plus explicitly named `--also` paths, and nothing else. Unrelated dirty files stay dirty — by design.
- **It does not edit `MEMORY.md` or `CLAUDE.md`.** It warns when `MEMORY.md` grows past 200 lines; the edit is yours.
- **It does not publish anything.** `STATE.md` is internal state-of-play, never a public artifact — on a public remote it stays gitignored and uncommitted.
---
## The Problem
Long sessions fill the context window. The classic failure mode is summarizing, committing, and writing a continuation prompt under time pressure — or skipping steps and losing continuity. Earlier versions of this plugin attacked that with auto-trigger hooks that wrote a separate `NEXT-SESSION-PROMPT` artifact.
@ -104,29 +143,7 @@ The `👉 NESTE` block is always first, right after the title — it carries the
## Quick Start
### Prerequisites
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) v2.x+
- Node.js (any recent LTS — for the helper script)
- A git repository (the helper detects detached HEAD / missing upstream and reports gracefully)
### Install
```bash
claude plugin marketplace add https://git.fromaitochitta.com/open/ktg-plugin-marketplace.git
```
Or enable directly in `~/.claude/settings.json`:
```json
{
"enabledPlugins": {
"graceful-handoff@ktg-plugin-marketplace": true
}
}
```
### Hand off
Installed? Then the whole workflow is one command:
```
> /graceful-handoff
@ -261,7 +278,7 @@ node --test 'tests/**/*.test.mjs'
| `tests/scripts/handoff-pipeline.test.mjs` | `--plan`/`--commit`/`--dry-run`, nearest-STATE resolution, remote classification, **no-`git add -A` regression**, gitignored-STATE skip, detached HEAD |
| `tests/plugin-manifest.test.mjs` | plugin.json version + description, CHANGELOG `[3.0.0]` BREAKING + preserved history |
The suite runs in a few seconds — no LLM involvement.
The suite runs in a few seconds — no LLM involvement. **Nothing runs it automatically:** this forge has no CI runner, so the command above from a clean clone is the only verification. That is also why this README carries no test badge — a static one would assert a run nobody performed.
---
@ -273,8 +290,6 @@ The suite runs in a few seconds — no LLM involvement.
- **Remote-aware tracked/local-only policy** so `STATE.md` never leaks to a public mirror.
- **Removed the Sonnet pin** — handoff synthesis inherits the session model.
Full history in [`CHANGELOG.md`](CHANGELOG.md).
---
## Limitations & Open Assumptions
@ -285,6 +300,12 @@ Full history in [`CHANGELOG.md`](CHANGELOG.md).
---
## Changelog
See [CHANGELOG.md](CHANGELOG.md).
---
## License
MIT. See [`LICENSE`](LICENSE).
@ -295,4 +316,4 @@ MIT. See [`LICENSE`](LICENSE).
- **Bug reports + feature requests:** open an issue on [Forgejo](https://git.fromaitochitta.com/open/ktg-plugin-marketplace)
- **Pull requests:** not accepted on this repo (solo project, dialog-driven development with Claude Code). Fork freely if you need to extend.
- **Marketplace:** part of [ktg-plugin-marketplace](https://git.fromaitochitta.com/open/ktg-plugin-marketplace) — see the [root README](../../README.md) for related plugins.
- **Marketplace:** part of [ktg-plugin-marketplace](https://git.fromaitochitta.com/open/ktg-plugin-marketplace) — see the catalog for related plugins.