Keep every paper you read on your own computer, and let an AI assistant do the filing.
Open a paper, highlight it, write your notes beside it — everything stays in ordinary files and folders that you can read, copy, and back up yourself, with or without litman. For anything past reading, just say what you want — add this paper, which ones did I read for the peptide project? — and your AI assistant does it.
Install
macOS / Linux:
curl -LsSf https://raw.githubusercontent.com/wqx1999/litman/main/install.sh | sh
Windows (PowerShell):
powershell -ExecutionPolicy ByPass -c "irm https://raw.githubusercontent.com/wqx1999/litman/main/install.ps1 | iex"
Double-click the litman icon the installer creates — desktop on Windows, Launchpad on macOS, applications menu on Linux.
Install with pipx
pipx builds litman's environment from the Python already on
your machine, so it needs Python 3.12 or newer on your PATH.
pipx install litman
lit gui --make-shortcut # the icon — the one-line installer does this step for you
Install from a local clone (development)
# first install
git clone https://github.com/wqx1999/litman.git
cd litman
pipx install .
# update (pull latest code first)
git pull
pipx install --force .
The AI assistant
Reading and annotating work on their own. The just say what you want layer runs
on an AI agent, which you install separately — litman ships the skills it
drives, not a model. lit agent starts yours in the library directory; the app's
agent button does the same.
Claude Code is the supported agent today. Codex, Cursor, Gemini CLI, and OpenCode are next: they already appear in litman's agent picker, greyed out until the release that turns them on.
Your agent works with whatever model you give it. We ran eight of them through 22 everyday tasks:
- Recommended: an Anthropic subscription. Claude Sonnet 4.6 and Haiku 4.5 both complete 97% of the tasks.
- Without one, DeepSeek-V4 scores highest of the rest.
Every write is validated whatever the model, so a weaker one needs more turns but never corrupts the library. Method and per-model scores: agent model benchmark.
Update and uninstall
Update litman
lit self-update upgrades litman through whichever tool installed it, uv or pipx.
It prints current → latest and asks once.
litman also asks PyPI for the newest version number once a day, and prints a line
when yours is older. LITMAN_NO_UPDATE_CHECK=1 switches that off —
what it checks.
Uninstall litman
Two steps, in order, while the lit command still exists:
lit uninstall # bundled skills, desktop shortcut, shell completion, vault registry, agent preferences, app-window browser profile
uv tool uninstall litman # or: pipx uninstall litman
lit uninstall lists what it will delete and asks first — --dry-run previews,
-y skips the prompt. Your vault (papers, PDFs, notes, annotations) is never
touched by any of this; delete that directory by hand if you want the data gone.
Documentation
Full documentation lives under docs/. New to litman? The
tutorial covers about 80% of everyday use.
| Topic | File |
|---|---|
| Start here — docs map | docs/0-readme.md |
| Design philosophy | docs/1-philosophy.md |
| Four-layer architecture | docs/2-architecture.md |
| Concepts and field reference | docs/3-concepts.md |
| Command reference | docs/4-commands.md |
| Tutorial | docs/5-tutorial.md |
| Agent model benchmark | docs/6-agent-benchmark.md |
Acknowledgments
Developed in the Süssmuth Lab, Technische Universität Berlin, with access to the TU Berlin HPC cluster.
Built with:
Standing on:
Cloud sync runs on rclone, installed separately.
The litman wordmark is adapted from Nunito.
License
MIT. See LICENSE.
AI agents: a condensed, link-dense map of this project lives in README-Agent.md.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file litman-1.2.0.tar.gz.
File metadata
- Download URL: litman-1.2.0.tar.gz
- Upload date:
- Size: 1.3 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5298585afa5e38e88a4b55f3dcc459b654df0f195b8fd325c7d85a6162940e2e
|
|
| MD5 |
9d1fe3a42a2015052ea597b4145bd564
|
|
| BLAKE2b-256 |
37c7c7a2057dee7c1d65070ff0609dd6d129f51ff2318756349fd622c03722bc
|
File details
Details for the file litman-1.2.0-py3-none-any.whl.
File metadata
- Download URL: litman-1.2.0-py3-none-any.whl
- Upload date:
- Size: 1.4 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e03c0e8cb81093340d3a79a96f8db61d480908c0a11fc16a06c27639e23165b3
|
|
| MD5 |
15d79475a6c2653e4f64832d62967d69
|
|
| BLAKE2b-256 |
c5d6188a7e39a202e4bae4d86c8d0a32b0f8028dd139620feabba855ac3a81b3
|