Welcome to papis’ documentation!

Papis is a command-line based document and bibliography manager. Its command-line interface (CLI) is heavily tailored after Git.

• Quick start
  • Creating a new library
  • Adding the first document
• Installation
  • Using pip
  • Archlinux
  • NixOS
  • From source
  • Requirements
  • Running tests
• Configuration file
  • Local configuration files
  • Python configuration file
  • General settings
  • Tools options
  • Bibtex options
  • papis add options
  • papis browse options
  • papis edit options
  • Marks
  • Downloaders
  • Databases
  • Terminal user interface (picker)
  • FZF integration
  • Other
• The info.yaml file
• The library structure
• The database
  • Papis database
  • Whoosh database
• Commands
  • Add
  • Addto
  • Browse
  • Bibtex
  • Config
  • Main
  • Edit
  • Explore
  • Export
  • Git
  • List
  • Mv
  • Open
  • Rename
  • Rm
  • Run
  • Update
• Web Application
• Gui
• Hooks
  • 1 Writing hooks as a user
  • 2 Writing hooks as a developer
• Custom scripts
  • Example: Mail script
  • Example: Accessing papis from within mutt
  • Example: Define papis mode in i3wm
  • Useful links
• API
• Plugin architecture
  • General architecture
  • Exporter
  • Command
  • Importer
  • Explore
• Git
  • Interplay with other commands
  • Updating the library
  • Usual workflow
• Scihub support
• Importing from bibtex or zotero
• Shell auto-completion
  • Zsh
• FAQ

Indices and tables

• Index

• Module Index

• Search Page