Skip to main content
litman

Website PyPI version Python 3.12+ License: MIT AI-native: agentic tool

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://get.litman.dev/install.sh | sh

Windows (PowerShell):

powershell -ExecutionPolicy ByPass -c "irm https://get.litman.dev/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

Pick an agent to drive litman through its bundled skills; you bring the model — use whatever you already pay for. Start with Claude Code.

Agent CLI Recommended model
Claude Code Official subscription
Codex Official subscription
Antigravity CLI Official subscription
Cursor Composer 2.5
OpenCode MiniMax-M3

Every write is validated, so a weaker model just needs more turns — it never corrupts the library. Scores and method: agent model benchmark.

Update and uninstall

Update litman

When a new release is out, a chip with its version number appears next to the logo in the Web UI. Click it and choose Update & restart: litman closes, upgrades, and reopens by itself.

From a terminal, lit self-update does the same through whichever tool installed litman, uv or pipx. It prints current → latest and asks once.

litman asks PyPI for the newest version number once a day, and mentions it when yours is older; lit hello tells you every time you ask. LITMAN_NO_UPDATE_CHECK=1 switches all of it 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:

Claude Code Cursor

Standing on:

Click FastAPI Uvicorn ruamel.yaml pypdf Pydantic Rich httpx

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

litman-1.3.4.tar.gz (2.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

litman-1.3.4-py3-none-any.whl (2.3 MB view details)

Uploaded Python 3

File details

Details for the file litman-1.3.4.tar.gz.

File metadata

  • Download URL: litman-1.3.4.tar.gz
  • Upload date:
  • Size: 2.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for litman-1.3.4.tar.gz
Algorithm Hash digest
SHA256 c8ca88d4d4c4cfdfb6113a1f155101f2d499913ecc0a248a21d1f9942f1e4772
MD5 da202b7778b62dde1fd5b7e68cb92639
BLAKE2b-256 b6d76dc8a5863dae87486ee1fe82dbc24a192ea940340a92aa933c53d5dfa627

See more details on using hashes here.

File details

Details for the file litman-1.3.4-py3-none-any.whl.

File metadata

  • Download URL: litman-1.3.4-py3-none-any.whl
  • Upload date:
  • Size: 2.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for litman-1.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2a9973709a0fa759bc3d4c915c58c06ccaabdd481d7a09473738e99cfc5e9cf3
MD5 f98d41f92b88f74b70644fbfa7d9eba2
BLAKE2b-256 22cd6116456f356bd4ab14eb24c853676453a8cad0ab9fa042e43e0c82d2e278

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page