Papis
The papis
command (without any subcommands) can be used to set configuration
options or select the library.
Examples
To override some configuration options, you can use the
--set
flag. For instance, if you want to override theeditor
used to edit files or theopentool
used to open documents, you can just typepapis --set editor gedit --set opentool firefox edit papis --set editor gedit --set opentool firefox open
If you want to list the libraries and pick one before sending a database query to papis, use
--pick-lib
as suchpapis --pick-lib open 'einstein relativity'
Command-line Interface
papis [OPTIONS] COMMAND [ARGS]...
Options
- -h, --help
Show this message and exit.
- --version
Show the version and exit.
- -v, --verbose
Make the output verbose (equivalent to –log DEBUG)
- --profile <profile>
Print profiling information into file
- -l, --lib <lib>
Choose a library name or library path (unnamed library)
- -c, --config <config>
Configuration file to use
- --pick-lib
Pick library to use
- -s, --set <set_list>
Set key value, e.g., –set info-name information.yaml –set opentool evince
- --color <color>
Prevent the output from having color
- Options:
always | auto | no
- --log <log>
Logging level
- Options:
INFO | DEBUG | WARNING | ERROR | CRITICAL
- --logfile <logfile>
File to dump the log
- --np <np>
Use number of processors for multicore functionalities in papis
Commands
- add
Add a document into a given library
- addto
Add files to an existing document
- bibtex
Interact with BibTeX files
- browse
Open document’s url in a browser
- cache
Manage the cache or database of a Papis library.
- citations
Handle document citations
- config
Print configuration values
- doctor
Check for common problems in documents
- edit
Edit document information from a given library
- exec
Execute a python file in the environment of papis’ executable
- explore
Explore new documents using a variety of resources.
- export
Export a document from a given library
- git
Run git command in a library or document folder
- init
Initialize a papis library
- list
List document metadata
- merge
Merge two documents from a given library
- mv
Move a document into some other path
- open
Open document from a given library
- rename
Rename document folders
- rm
Delete a document, a file, or a notes-file
- run
Run an arbitrary shell command in the library or command folder
- serve
Start a papis server
- tag
Change a document’s tags.
- update
Update document metadata