Skip to content

nickleodoen/resume

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

32 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸͺΌ Resume - Coder Session AI Assistant

Keep your developer flow state. Never lose context between coding sessions. Dive right back.

resume watches your project while you work β€” file changes, git diffs, shell commands β€” and stores them locally. When you come back, one command calls an LLM and prints a plain-English briefing of what you were doing, what you finished, and what to do next.

Resy the jellyfish


Screenshots

Dashboard Briefing
Dashboard Briefing
Help & Models Notes
Help Notes

Install

Option 1 β€” Download a pre-built binary (no Rust required)

Go to the Releases page and download the archive for your platform:

Platform File
macOS Apple Silicon resume-vX.Y.Z-aarch64-apple-darwin.tar.gz
macOS Intel resume-vX.Y.Z-x86_64-apple-darwin.tar.gz
Linux x86_64 resume-vX.Y.Z-x86_64-unknown-linux-gnu.tar.gz

Extract and move to your PATH:

tar -xzf resume-*.tar.gz
sudo mv resume /usr/local/bin/

Option 2 β€” Install with Cargo

cargo install --git https://github.com/nickleodoen/resume

Quick Start

# Set your Anthropic API key β€” add to ~/.zshrc or ~/.bashrc to make it permanent
export ANTHROPIC_API_KEY=sk-ant-...

# Or store it in a .env file in your project (resume loads it automatically)
echo 'ANTHROPIC_API_KEY=sk-ant-...' >> .env

# Run in any git project
cd your-project
resume

resume opens a live dashboard. Work normally. Press Ctrl-C to stop the session.

Next time you open the project, run resume show to get your briefing.


Shell Hook Setup (Recommended)

Without the shell hook, resume only captures file changes. With it, your shell commands are captured too β€” this makes briefings significantly more useful.

resume init --install-hook
# then open a new terminal (or source ~/.zshrc / ~/.bashrc)

This appends a small hook to ~/.zshrc (zsh) or ~/.bashrc (bash) that logs commands to the active session. It's idempotent β€” safe to re-run. It also adds .resume/ to your project's .gitignore.


IDE Integration

resume currently has first-class VS Code integration built in β€” the .vscode/ config sets up truecolor support so Resy and the briefing render with full color in the terminal panel.

Other editors: resume works in any terminal emulator β€” just run resume from your project directory. Integrations for other IDEs are planned.


TUI Commands

While the dashboard is open, type any of these and press Enter:

Command What it does
show Generate and display a briefing for this session
cancel Cancel an in-progress briefing
finish Archive this session and start a fresh one
note <text> Save a persistent note for this project
notes Show all saved notes
notes clear Delete all notes for this project
help Show the full command reference

Model switching: Press Shift+Tab to cycle through available models (only models that are actually reachable are shown β€” no Anthropic key means no cloud models, missing Ollama pulls are hidden automatically). The current model is shown in the bottom bar.

Scroll: Arrow keys or PgUp/PgDn to scroll the briefing panel.


CLI Commands

resume show                    # Generate a briefing (outside of TUI)
resume status                  # Print all captured events raw
resume note "something to remember"
resume notes                   # List all notes
resume init --install-hook     # Set up the shell hook

Local Models (Ollama)

resume works without an Anthropic API key if you have Ollama running locally.

Install Ollama: https://ollama.ai/download

Supported models (install any or all β€” only pulled models appear in Shift+Tab cycling):

ollama pull qwen3.5               # Fast, general-purpose (~2GB)
ollama pull qwen3-coder:30b       # Strong code understanding (~18GB)
ollama pull deepseek-coder-v2:16b # Code-focused (~9GB)

Make sure Ollama is running (ollama serve) before launching resume. The TUI detects available local models on startup automatically.


Requirements

  • macOS or Linux
  • ANTHROPIC_API_KEY or at least one Ollama model pulled and ollama serve running
  • Rust 1.89+ only if installing via cargo install

Project Layout

src/
β”œβ”€β”€ main.rs       β€” CLI entry point and subcommand dispatch (clap)
β”œβ”€β”€ session.rs    β€” Session data model, central storage under ~/.resume/projects/
β”œβ”€β”€ watcher.rs    β€” File system watcher (notify), git diff capture, noise filtering
β”œβ”€β”€ git.rs        β€” git2 diff and commit log helpers
β”œβ”€β”€ summarize.rs  β€” Prompt builder + Anthropic/Ollama API calls
β”œβ”€β”€ models.rs     β€” Model registry and provider dispatch
└── tui.rs        β€” Live ratatui/crossterm dashboard (Resy the jellyfish lives here)

Session data is stored in ~/.resume/projects/<your-project-path>/ β€” nothing is written to your project repository.

About

Your own coder session assistant. Any project. Any LLM. The jellyfish way. πŸͺΌ

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages