olib

olib (Obsidian Librarian) is a package that gives you more time for real thinking by:

1. Formatting your notes correctly
2. Pointing out gaps in understanding
3. Shortlisting interesting connections between ideas

Installation

pip install obsidian-librarian

Usage

olib [command] [subcommand] [options]

Global Options

• --tags, -t Filter by tags (e.g., --tags economy,history)
• --notes, -n Specify note names
• --period, -p Time period (default: last 24h)
• --help, -h Show help message
• --version, -v Show version number

Commands

# Core Commands
format              Format notes and convert screenshots to text
check               Run various checks on notes
  accuracy          Check note accuracy and completeness
  private           Detect private/sensitive content

search              Search and analyze notes
  semantic          Perform semantic search across notes
  prereq            Identify missing prerequisites

# Note Management
notes               Note manipulation commands
  format            Format individual notes
  fill              Complete partial notes
  ocr               Convert screenshots to text
  autolink          Automatically add links to notes
  check-garbage     Find and clean up problematic files

# System
analytics           Display note-taking analytics dashboard
config              Manage configuration
  prompt            Configure formatting prompts
history             Show command history
undo                Revert last command

Philosophy

Read more about the philosophy behind Obsidian Librarian here.

• Effective Learning: Notes should enhance learning through:

  • Building atomic knowledge
  • Fostering creative connections

• Deliberate Understanding: Learning must be effortful:

  • Document clear understanding
  • Explicitly mark gaps for further study

License

MIT License. See LICENSE for details.

Shell Completion Setup

Automatic Setup (Recommended)

This package uses Click for CLI functionality. To enable autocompletion automatically:

pip install "obsidian-librarian[completion]"

Manual Setup

If the automatic setup doesn't work, you can manually enable completions:

For Zsh, add to your ~/.zshrc:

eval "$(_OLIB_COMPLETE=zsh_source olib)"

For Bash, add to your ~/.bashrc:

eval "$(_OLIB_COMPLETE=bash_source olib)"

For Fish, add to your ~/.config/fish/completions/olib.fish:

eval (env _OLIB_COMPLETE=fish_source olib)

After adding these lines, restart your shell or run:

source ~/.zshrc  # for Zsh
# or
source ~/.bashrc  # for Bash