Skip to main content

Command line utility to interact with Obsidian, providing much needed features.

Project description

Obsidian CLI

PyPI Package

Command line utility to interact with Obsidian. Notable features:

  • List Obsidian vaults (obsidian ls -l)
  • Open folders as vaults from the command line (obsidian open {PATH})
  • Create vaults from templates (obsidian new {PATH})
    • You can share vault settings (e.g. keybindings) with the template via hardlinks, so when you edit the template keybindings, it affects all vaults
  • Customize the new vault template and create new vaults (obsidian template edit)

Installation and Usage

Python 3.11 or newer required.

uv tool install obsidian-cli
obsidian --install-completion
obsidian --help

This package can also be used as a Python API for Obsidian:

from obsidian_cli import ObsidianConfig, open_vault
from pathlib import Path

print(ObsidianConfig.load())

open_vault(Path(R"C:\example-vault"))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

obsidian_cli-1.0.1.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

obsidian_cli-1.0.1-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file obsidian_cli-1.0.1.tar.gz.

File metadata

  • Download URL: obsidian_cli-1.0.1.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.13

File hashes

Hashes for obsidian_cli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 3564d484e944a73de62ecac560240f50e81b34ff87057fed93f3b876cf271396
MD5 4dc88c9006f21eb27db7faf46303be52
BLAKE2b-256 6eac6380f7bffecbd526aa53cf804e348f2f4caac09c300e9dfac3e14be9ea06

See more details on using hashes here.

File details

Details for the file obsidian_cli-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for obsidian_cli-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a0396da33958a91dd6b2d8fb80cc1dbe02c6dedac0827edafa6dcb933c977ad
MD5 fa4a4eabf20eaa0948900bc375894f50
BLAKE2b-256 ce147477f9a62bf464de1d241113d36a786b699e0f7fb76af0362fd2f0683c6a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page