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://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

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

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:

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.1.tar.gz (2.0 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.1-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: litman-1.3.1.tar.gz
  • Upload date:
  • Size: 2.0 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.1.tar.gz
Algorithm Hash digest
SHA256 23fb7eec1ed7e239c605e531ef96c2adb97c1d14ad0542c849ebc13bcd83d2a2
MD5 0d36100dc7711a6df96d8a7b67d6f998
BLAKE2b-256 9f99e016ef2b81e2617e88acb5be4098ada978d5f3f654576dba110226531ea6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: litman-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 2.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 30a3bca447b8aa2d394bba6c52b83ef02c6d94c11df36b247e723c968c1ebea1
MD5 c8472d00ee000322a12e839fe4699835
BLAKE2b-256 ca8a9fd4b7d2f43c39c6ff15a2a8179b31f6959006d8849477b4b24eea0f4cfb

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