Skip to main content

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"))

Metadata

Release files for obsidian-cli 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for obsidian-cli 1.0.2
File Size Uploaded Provenance Actions
obsidian_cli-1.0.2.tar.gz 6.6 kB Without provenance Details for obsidian_cli-1.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for obsidian-cli 1.0.2
File Interpreter ABI Platform Actions
obsidian_cli-1.0.2-py3-none-any.whl Python 3 none any Details for obsidian_cli-1.0.2-py3-none-any.whl

Total release size: 15.8 kB

Release files / obsidian_cli-1.0.2.tar.gz

Download URL obsidian_cli-1.0.2.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
0012fbdfd89b00d13392d29ad10ff17010937a7c6c4f1419ff2db54119bdb0b3
BLAKE2b-256 checksum
How to use checksums
2e52042e9369a37b65dc2b37da925593edb866b0b1092dd57a784b6ad3451626
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.13

Release files / obsidian_cli-1.0.2-py3-none-any.whl

Download URL obsidian_cli-1.0.2-py3-none-any.whl
Size 9.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cf73668314215fa24f29b68695fdddf983298a646b8ed281a70f7d6ab27decfe
BLAKE2b-256 checksum
How to use checksums
a941ff77600b8f17d82e52e9d8eee09672ffd98e341099903b3fe82b6f973e7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.8.13

Security for obsidian-cli 1.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page