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.2.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.2-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: obsidian_cli-1.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 0012fbdfd89b00d13392d29ad10ff17010937a7c6c4f1419ff2db54119bdb0b3
MD5 e73d884665cbb80395f8039151bd76d8
BLAKE2b-256 2e52042e9369a37b65dc2b37da925593edb866b0b1092dd57a784b6ad3451626

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for obsidian_cli-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cf73668314215fa24f29b68695fdddf983298a646b8ed281a70f7d6ab27decfe
MD5 10cf19fff6c83da8ff5c66b320b4a88f
BLAKE2b-256 a941ff77600b8f17d82e52e9d8eee09672ffd98e341099903b3fe82b6f973e7d

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