https://github.com/pushfoo/obsidian-runny
Misc Obsidian run helpers.
https://github.com/pushfoo/obsidian-runny
Last synced: 8 months ago
JSON representation
Misc Obsidian run helpers.
- Host: GitHub
- URL: https://github.com/pushfoo/obsidian-runny
- Owner: pushfoo
- Created: 2025-08-03T04:24:37.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-08T22:21:03.000Z (10 months ago)
- Last Synced: 2025-08-09T00:19:50.387Z (10 months ago)
- Language: Python
- Size: 21.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# obsidian-runny
CLI helpers for [Obsidian][] using Python 3.12+.
## Examples
> [!TIP]
> Add a shorthand [shell alias][] to use a different command
[shell alias]: https://unix.stackexchange.com/questions/146419/creating-an-alias-for-a-bash-script
```shell
obsidian_runny new --name "New Example Note"
```
This command creates a new blank note:
- with the given `--name` (New Example Note)
- inside the most recently used Obsidian vault
## Installing
> [!IMPORTANT]
> Pre-alpha software means you should expect bugs.
### Requirements
1. Python 3.12+
2. [Obsidian][]
3. A high tolerance for unfinished software
> [!NOTE]
> [`pipx`][pipx] is also useful for use as a system-wide utility.
### Installing
| Approach | Command |
|-------------|-----------------------------------------------------------------------------|
| Local venv | `pip install git+https://git+https://github.com/pushfoo/obsidian-runny.git` |
| System-wide | `pipx install git+https://github.com/pushfoo/obsidian-runny.git` |
> [!CAUTION]
> **Never** attempt to use `sudo` with `pip`! ([Learn why](#why-never-sudo-pip-install))
[Obsidian]: https://obsidian.md/
[pipx]: https://pipx.pypa.io/
## Errata
### Why never `sudo pip install`?
**TL;DR:** It's the fastest way to break your system.
Especially on `apt`-based Linux distros, it is a bad time. Just
don't do it.
1. The override flag is `--break-system-packages` for a reason
2. The `apt` package manager relies on the "system" Python install
3. If you break system Python, you also break:
* `apt` (can't install software)
* network utilities (not always, but it hurts)
Reinstalling is often faster than manually fixing the issues,
but it is also no fun.
#### Ok, what should I use then?
Instead, use one of the following:
* [`pipx`][pipx]
* [`uv`][uv]
* An ordinary virtual environment (venv)
* Any other reputable tool
[uv]: https://docs.astral.sh/uv/