LEIBOWITZ(1)                         General Commands Manual                       LEIBOWITZ(1)

NAME
       leibowitz — A lispy object‐storage layer for unix file systems.

SYNOPSIS
       leibowitz  [-‐version]  [-‐help]  [-e,  -‐eval  VALUE]  [-r,  -‐root PATH] [-s, -‐slynk]
                 [-p,   -‐slynk‐port   INT]   [-w,   -‐slynk‐wait]    [-c,    -‐config    PATH]
                 [-n, -‐no‐config]
       leibowitz help [-‐version] [-‐help] [<subcommand>]
       leibowitz info [-‐version] [-‐help]
       leibowitz index [-‐version] [-‐help] [<paths...>]
       leibowitz web [-‐version] [-‐help] [-p, -‐port INT]
       leibowitz   find   [-‐version]   [-‐help]   [-r,   -‐reverse]   [-s,   -‐sort‐by  VALUE]
                 [<search terms...>]
       leibowitz show [-‐version] [-‐help] [<paths...>]
       leibowitz mv [-‐version] [-‐help] [-f, -‐force] [<source> <destination>]
       leibowitz cp [-‐version] [-‐help] [-f, -‐force] [<source> <destination>]
       leibowitz rm [-‐version] [-‐help] [<paths...>]
       leibowitz  ls  [-‐version]  [-‐help]  [-t,   -‐tag   ITEM]   [-s,   -‐sort‐by   VARIANT]
                 [-m, -‐mime VALUE] [-u, -‐unindexed] [-r, -‐reverse] [<directories...>]
       leibowitz tag [-‐version] [-‐help]
       leibowitz tag help [-‐version] [-‐help] [<subcommand>]
       leibowitz tag show [-‐version] [-‐help] [<tag names...>]
       leibowitz tag ls [-‐version] [-‐help] [-n, -‐no‐label] [<paths...>]
       leibowitz    tag    mv    [-‐version]    [-‐help]    [-f,    -‐force]    [-m,   -‐merge]
                 [<source> <destination>]
       leibowitz   tag    cp    [-‐version]    [-‐help]    [-f,    -‐force]    [-m,    -‐merge]
                 [<source> <destination>]
       leibowitz tag rm [-‐version] [-‐help] [<tag names...>]
       leibowitz tag edit [-‐version] [-‐help]
       leibowitz tag edit help [-‐version] [-‐help] [<subcommand>]
       leibowitz tag edit tags [-‐version] [-‐help] [-r, -‐replace] [-e, -‐edit] [-i, -‐invert]
                 [-c, -‐cascade] [<path> <tags names...>]
       leibowitz   tag   edit   files   [-‐version]   [-‐help]  [-r,  -‐replace]  [-e,  -‐edit]
                 [-i, -‐invert] [-c, -‐cascade] [<tag name> <paths...>]
       leibowitz  tag  edit  parents  [-‐version]  [-‐help]  [-r,   -‐replace]   [-e,   -‐edit]
                 [-i, -‐invert] [<tag names...>]
       leibowitz   tag   edit  children  [-‐version]  [-‐help]  [-r,  -‐replace]  [-e,  -‐edit]
                 [-i, -‐invert] [<tag names...>]
       leibowitz tag edit label [-‐version] [-‐help] [-e, -‐edit] [<tag name> <label>]

DESCRIPTION
       Leibowitz is a personal library management engine.  It consists of a Common Lisp library
       exposed as a command‐line utility and a web interface that act as an  abstraction  layer
       over  the  Unix  file system, providing a number of extra features.  These include mutu‐
       ally‐inclusive file tagging, full text search (using an index and  extractors  for  non‐
       textual  files,  so  it’s  faster and more complete than grep), and easy modification in
       Common Lisp directly.  See the EXAMPLES section for advice on how to get  started  using
       Leibowitz to manage files.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -e, -‐eval VALUE
               Evaluate a Lisp form in the leibowitz package immediately after setup.

       -r, -‐root PATH (env: LEIBOWITZ_ROOT)
               Specify a directory in which to run in root mode.

       -s, -‐slynk (env: LEIBOWITZ_RUN_SLYNK)
               Run a slynk server for interactive debugging.

       -p, -‐slynk‐port INT (env: LEIBOWITZ_SLYNK_PORT) (default: 4005)
               Specify the port slynk will listen in.

       -w, -‐slynk‐wait (env: LEIBOWITZ_SLYNK_WAIT)
               Wait for a slynk/swank client to connect before doing anything.

       -c, -‐config PATH (env: LEIBOWITZ_CONFIG)
               Specify an alternate config file.

       -n, -‐no‐config
               Disable loading config file.

   leibowitz help <subcommand>
       Another way to print help info.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz info
       Print information and statistics about the dataset.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz index <paths...>
       Recursively index a file or files, reading from stdin if none are specified.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz web
       Display a web UI.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -p, -‐port INT (env: LEIBOWITZ_WEB_PORT) (default: 5000)
               Specify a port on which to run the web UI.

   leibowitz find <search terms...>
       Search your data.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -r, -‐reverse
               Reverse sort direction, default shows best match at top.

       -s, -‐sort‐by VALUE (default: rank)
               Criterion to sort search results by, default is rank.

   leibowitz show <paths...>
       Print information about files.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz mv <source> <destination>
       Move or rename a file, keeping metadata and tags intact.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -f, -‐force
               Overwrite existing files.

   leibowitz cp <source> <destination>
       Copy a file, duplicating its tags and metadata.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -f, -‐force
               Overwrite new if it exists.

   leibowitz rm <paths...>
       Remove a file, including all tag and metadata associations.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz ls <directories...>
       List indexed files.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -t, -‐tag ITEM
               Filter by tag, may be pass multiple times.

       -s, -‐sort‐by (options: modified, birth, accesses) (default: modified)
               Criterion by which to sort files.

       -m, -‐mime VALUE
               Filter by mime type.

       -u, -‐unindexed
               Include unindexed files.

       -r, -‐reverse
               Reverse sort order of results.

   leibowitz tag
       Parent command for all tag operations.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz tag help <subcommand>
       Print help for tag subcommands.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz tag show <tag names...>
       Show information about one or more tags.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz tag ls <paths...>
       List tags, optionally filtered to union of specified paths.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -n, -‐no‐label
               Don’t print tag labels; useful for Unix scripting.

   leibowitz tag mv <source> <destination>
       Move or rename a tag.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -f, -‐force
               Overwrite dst if it already exists.

       -m, -‐merge
               Merge src into dst if dst already exists.

   leibowitz tag cp <source> <destination>
       Copy a tag.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -f, -‐force
               Overwrite dst if it already exists.

       -m, -‐merge
               Merge src into dst if dst already exists.

   leibowitz tag rm <tag names...>
       Remove one or more tags.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz tag edit
       Edit tag files and parents, reading from stdin if arguments are omitted.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz tag edit help <subcommand>
       Print help for tag edit subcommands.

       -‐version
               display version and exit

       -‐help  display usage information and exit

   leibowitz tag edit tags <path> <tags names...>
       Add (default) or remove multiple tags on a single file.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -r, -‐replace
               Replace this file’s tags, meaningless with ‐c.

       -e, -‐edit
               Edit the list of tags in $EDITOR, implies ‐r.

       -i, -‐invert
               Invert the selection to remove rather than add.

       -c, -‐cascade
               Also remove parent tags from path, needs ‐i.

   leibowitz tag edit files <tag name> <paths...>
       Add (default) or remove a single tag for multiple files

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -r, -‐replace
               Replace this tag’s files, meaningless with ‐i.

       -e, -‐edit
               Edit the list of files in $EDITOR, implies ‐r.

       -i, -‐invert
               Invert the selection to remove rather than add.

       -c, -‐cascade
               Also remove parent tags from path, needs ‐r, ‐e, or ‐i.

   leibowitz tag edit parents <tag names...>
       Add (default) or remove parent tags of a tag.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -r, -‐replace
               Replace this tag’s parents with the specified list.

       -e, -‐edit
               Edit the list of parent tags in $EDITOR, implies ‐r

       -i, -‐invert
               Invert the selection to remove rather than add.

   leibowitz tag edit children <tag names...>
       Add (default) or remove child tags of a tag.

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -r, -‐replace
               Replace this tag’s children with the specified list.

       -e, -‐edit
               Edit the list of child tags in $EDITOR, implies ‐r.

       -i, -‐invert
               Invert the selection to remove rather than add.

   leibowitz tag edit label <tag name> <label>
       Edit a tag’s label, replacing it if it already exists

       -‐version
               display version and exit

       -‐help  display usage information and exit

       -e, -‐edit
               Edit the label in $EDITOR.

ENVIRONMENT
       LEIBOWITZ_ROOT -r, -‐root PATH
           Specify a directory in which to run in root mode.

       LEIBOWITZ_RUN_SLYNK -s, -‐slynk
           Run a slynk server for interactive debugging.

       LEIBOWITZ_SLYNK_PORT -p, -‐slynk‐port INT (default: 4005)
           Specify the port slynk will listen in.

       LEIBOWITZ_SLYNK_WAIT -w, -‐slynk‐wait
           Wait for a slynk/swank client to connect before doing anything.

       LEIBOWITZ_CONFIG -c, -‐config PATH
           Specify an alternate config file.

   leibowitz web
       LEIBOWITZ_WEB_PORT -p, -‐port INT (default: 5000)
           Specify a port on which to run the web UI.

EXAMPLES
       Leibowitz supports self‐contained libraries, meaning that for some value of the variable
       LEIBOWITZ_ROOT,  all  metadata  pertaining  to the files under that directory are stored
       there.  This is useful if you’d like to have self‐contained libraries of different kinds
       of data, like your collections of ebooks, or memes, or whatever:

             $ export LEIBOWITZ_ROOT=/path/to/library/
             $ leibowitz index /path/to/library/
             Indexing /path/to/library/file_1.ext
              ...
             Indexing /path/to/library/file_n.ext
             $ find /path/to/library/.leibowitiz/ ‐type f
             /path/to/library/.leibowitz/ontology.db
             /path/to/library/.leibowitz/config.lisp
             /path/to/library/.leibowitz/cache/thumbnails/path/to/library/file_1.ext.jpg
              ...
             /path/to/library/.leibowitz/cache/thumbnails/path/to/library/file_n.ext.jpg
             $ leibowitz info
             Welcome to Leibowitz!
                  Config file: /path/to/library/.leibowitz/config.lisp
               Base directory: /path/to/library/
               Data directory: /path/to/library/.leibowitz/
              Cache directory: /path/to/library/.leibowitz/cache/
             SQLite Library on /path/to/library/.leibowitz/ontology.db with N tags and M files.

       If you DON’T set LEIBOWITZ_ROOT, all data will be stored in the  conventional  locations
       in  your  home  directory.   For this and for the preceding example, the only files Lei‐
       bowitz will know about are those you explicitly (or implicitly because of shell patterns
       or directory recursion) index.

             $ unset $LEIBOWITZ_ROOT
             $ leibowitz info
             Welcome to Leibowitz!
                  Config file: /home/you/.config/leibowitz/config.lisp
               Base directory: /home/you/
               Data directory: /home/you/.local/share/leibowitz/
              Cache directory: /home/you/.cache/leibowitz/
             SQLite Library on /home/you/.local/share/leibowitz/ontology.db with N tags and M files.

AUTHORS
       ꙮ <ymir@ulthar.xyz>

GNU                                         2024‐6‐1                               LEIBOWITZ(1)