Skip to content

armgit / cogit

Public Imported from GitHub
0

Git for the intent behind agent-written code. Records what your coding agent decided and why, and links every commit to it.

docs: say how to keep cogit updated and open the README with a demo

Eren5aab607c75ef
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2825b65..fee15af 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,6 +5,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
+### Added
+- When a new chat starts and the plugin and the `cogit` command on the PATH are different versions, a one-line notice says which one to update and how. Recording is not affected either way; the plugin's hooks run its own copy.
+- A new setting, `recordHeadless` (Settings → Headless sessions), off by default. Sessions started without a person, such as `claude -p`, are no longer recorded: some plugins start one in the background for every prompt, and each turned up as an empty session on the map and a new row in the "Your turn" inbox. Turn it on to record your own `claude -p` work.
+### Changed
+- The README and the getting-started guide say how to keep cogit updated: turn on auto-update for the cogit marketplace once (Claude Code leaves it off for marketplaces outside Anthropic's), and update the command with npm.
+- The README opens with a short recording: the panel, the map, a message hash opening the decision behind it, and `cogit why` on a file.
+### Fixed
+- `cogit why` works from any directory inside the project, with the path relative to where you are, as git does; it used to say the project was not initialized.
+- A cogit command piped into `head` or another reader that stops early exits quietly instead of printing a `write EPIPE` stack.
## [0.19.1] - 2026-10-28
### Changed
diff --git a/README.md b/README.md
index 891765a..a006c6c 100644
--- a/README.md
+++ b/README.md
@@ -6,10 +6,7 @@ Git remembers what changed. cogit remembers why.
<p align="center"><img src="docs/images/cogit-descartes.jpg" width="360" alt="René Descartes with git branches running through his hair"><br><i>Cogito, ergo commit.</i></p>
-<picture>
- <source media="(prefers-color-scheme: dark)" srcset="docs/images/map-dark.png">
- <img src="docs/images/map-light.png" alt="The map: sessions, branches and the decision behind a message">
-</picture>
+<img src="docs/images/demo.gif" alt="cogit open shows the projects, then the map; pasting a message hash opens the decision behind it, and cogit why lists the thoughts behind a file">
cogit records every message you send to an AI coding agent as a *thought commit*: what you
asked, what came of it, and the message it answered. Your code commits point back to the
@@ -56,6 +53,9 @@ Then, in Claude Code:
/plugin install cogit --marketplace erensrtky/cogit
```
+To get plugin updates on their own, turn on auto-update once: `/plugin` → Marketplaces →
+cogit → Enable auto-update. Claude Code leaves it off for marketplaces outside its own.
+
## Quick start
```bash
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
index 1091f4c..98343d4 100644
--- a/docs/guide/getting-started.md
+++ b/docs/guide/getting-started.md
@@ -20,7 +20,19 @@ The Claude Code plugin adds the skill that keeps the record and the hooks that m
/plugin install cogit --marketplace erensrtky/cogit
```
-A plugin update reaches a running session only after `/reload-plugins` or a new chat.
+### Updates
+
+The plugin and the `cogit` command update separately:
+
+- **Plugin**: Claude Code updates plugins on its own only for marketplaces that have
+ auto-update on, and it is off for every marketplace outside Anthropic's. Turn it on once:
+ `/plugin` → Marketplaces → cogit → Enable auto-update. Or update by hand with
+ `claude plugin update cogit@cogit`.
+- **Command**: `npm install -g @cogit/cli` again.
+
+A plugin update reaches a running session only after `/reload-plugins` or a new chat. When a
+new chat starts and the two versions differ, cogit says which one to update. Recording
+keeps working meanwhile: the plugin's hooks run the plugin's own copy of cogit.
## Set up a project
diff --git a/docs/images/demo.gif b/docs/images/demo.gif
new file mode 100644
index 0000000..75bddd7
Binary files /dev/null and b/docs/images/demo.gif differ
diff --git a/packages/cli/test/plugin-manifest.test.ts b/packages/cli/test/plugin-manifest.test.ts
index b2a8f25..9008a94 100644
--- a/packages/cli/test/plugin-manifest.test.ts
+++ b/packages/cli/test/plugin-manifest.test.ts
@@ -60,13 +60,12 @@ describe("plugin packaging", () => {
it("keeps a README that shows the map and points at the guide and licence", async () => {
const readme = await readFile(new URL("../../../README.md", import.meta.url), "utf8");
- // One screenshot per theme; GitHub shows the one that matches the reader's.
- expect(readme).toContain('srcset="docs/images/map-dark.png"');
- expect(readme).toContain('src="docs/images/map-light.png"');
+ // The demo recording; the per-theme screenshots stay in the map guide.
+ expect(readme).toContain('src="docs/images/demo.gif"');
expect(readme).toContain("(docs/guide/getting-started.md)");
expect(readme).toContain("(LICENSE)");
// A relative image only renders when the file it names is in the repository.
- for (const image of ["map-dark.png", "map-light.png"]) {
+ for (const image of ["demo.gif", "map-dark.png", "map-light.png"]) {
await expect(
access(new URL(`../../../docs/images/${image}`, import.meta.url)),
).resolves.toBeUndefined();