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
  • Citations options
  • Marks
  • Downloaders
  • Databases
  • Terminal user interface (picker)
  • FZF integration
  • Other
• The info.yaml file
• The library structure
• The database
  • Papis database
  • Whoosh database
• The papis_id key
  • Use of papis_id in scripts
• Citations of documents: citations.yaml and cited-by.yaml files
• Commands
  • Add
  • Addto
  • Browse
  • Bibtex
  • Config
  • Main
  • Edit
  • Explore
  • Export
  • Git
  • List
  • Mv
  • Open
  • Rename
  • Rm
  • Run
  • Update
  • Citations
• Web Application
• Gui
• Editor support
  • 1 VIM
  • 2 Emacs
• Hooks
  • 1 Writing hooks as a user
  • 2 Writing hooks as a developer
• Document
  • KeyConversion
  • KeyConversionPair
  • SortPriority
  • KeyConversion
  • KeyConversionPair
  • keyconversion_to_data()
  • author_list_to_author()
  • split_authors_name()
  • DocHtmlEscaped
  • Document
  • from_data()
  • from_folder()
  • to_json()
  • to_dict()
  • dump()
  • delete()
  • describe()
  • move()
  • sort()
  • new()
• Custom scripts
  • Example: Mail script
  • Example: Accessing papis from within mutt
  • Example: Define papis mode in i3wm
  • Useful links
• API
  • T
  • get_lib_name()
  • set_lib_from_name()
  • get_libraries()
  • pick_doc()
  • pick()
  • open_file()
  • open_dir()
  • edit_file()
  • get_all_documents_in_lib()
  • get_documents_in_dir()
  • get_documents_in_lib()
  • clear_lib_cache()
  • doi_to_data()
  • save_doc()
• 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 Completion
• FAQ

Indices and tables

• Index

• Module Index

• Search Page