Skip to content

update readme with how it works #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zachnormn merged 1 commit into from
Jan 7, 2026
Merged

update readme with how it works #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# c⌐■■vs

[github.com/picogrid/ceevs](https://github.com/picogrid/ceevs)

Terminal session receipts for physical receipt printers.

Every command you run, printed on thermal paper. Your shell history made tangible.
Expand All @@ -23,13 +25,15 @@ Every command you run, printed on thermal paper. Your shell history made tangibl

## What is this?

c⌐■■vs captures work sessions and prints executive summaries to thermal receipt printers. LLM summarization (haiku/gemini) distills raw events into what was accomplished.
c⌐■■vs captures work sessions and prints **executive summaries** to thermal receipt printers.

Raw events (commands, exit codes, timestamps) are captured via zsh hooks and Claude Code hooks, stored as JSONL, then summarized by a lightweight LLM (haiku/gemini) into 2-3 sentences describing what was accomplished—not a log of every command.

Print receipts when:
- a Linear issue is closed
- a plan is finished
- a Claude Code session completes
- a terminal session ends
Receipts print when:
- a Linear issue is marked done
- a plan (linked to Linear) is completed
- a Claude Code session ends
- a terminal session closes (optional)

## Receipt Template

Expand Down