kootszhin/obs

A blazingly fast & lightweight Obsidian CLI ⚡️

obs - the Obsidian CLI

⚡️ Connecting your second brain to the termainl - blazing fast ⚡️

Note 🚧

• obs is under active development and currently only support MacOS, please report any issue while using!

Features

• Fast & easy access to vaults from terminal in seconds
• Backup your vault to remote git effortlessly
• Flat learning curve without the need to memorize complciated commands
• Automatically fetch vault list from Obsidian, no extra config needed

Usage

• obs : open up a menu for choosing actions and vault to interact with
  • goto : goto vault
  • open : open vault
  • backup : backup vault
• obs --goto <GOTO> : cd to the directory of vault <GOTO>
• obs --open <OPEN> : open the vault <OPEN> in Obsidian
• obs --help : show help

Getting Started

1. Install obs

cargo install obs

2. Put this in your .zshrc (or equivalent)

obs() {
    local result=$(command obs "$@")
    [ -n "$result" ] && cd -- "$result"
}

3. Start using: obs!

License

MIT @ 2023: Distributed under the MIT License.