m/obsidian-metadata
1
0
Fork 0
mirror of https://github.com/natelandau/obsidian-metadata.git synced 2025-11-17 09:23:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): update install instructions

Browse Source
This commit is contained in:
Nathaniel Landau
2023-01-22 17:19:41 +00:00
parent 9123ee149f
commit c427a987c1
2 changed files with 17 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@@ -2,34 +2,29 @@
# obsidian-metadata # obsidian-metadata
A script to make batch updates to metadata in an Obsidian vault. Provides the following capabilities: A script to make batch updates to metadata in an Obsidian vault. Provides the following capabilities:
- in-text tag: delete every occurrence - `in-text tag`: delete every occurrence
- in-text tags: Rename tag (`#tag1` -> `#tag2`) - `in-text tags`: Rename tag (`#tag1` -> `#tag2`)
- frontmatter: Delete a key matching a regex pattern and all associated values - `frontmatter`: Delete a key matching a regex pattern and all associated values
- frontmatter: Rename a key - `frontmatter`: Rename a key
- frontmatter: Delete a value matching a regex pattern from a specified key - `frontmatter`: Delete a value matching a regex pattern from a specified key
- frontmatter: Rename a value from a specified key - `frontmatter`: Rename a value from a specified key
- inline metadata: Delete a key matching a regex pattern and all associated values - `inline metadata`: Delete a key matching a regex pattern and all associated values
- inline metadata: Rename a key - `inline metadata`: Rename a key
- inline metadata: Delete a value matching a regex pattern from a specified key - `inline metadata`: Delete a value matching a regex pattern from a specified key
- inline metadata: Rename a value from a specified key - `inline metadata`: Rename a value from a specified key
- vault: Create a backup of the Obsidian vault - `vault`: Create a backup of the Obsidian vault
## Install ## Install
`obsidian-metadata` requires Python v3.10 or above. `obsidian-metadata` requires Python v3.10 or above.
Use [PIPX](https://pypa.github.io/pipx/) to install this package from Github.
```bash ```bash
pipx install git+https://${GITHUB_TOKEN}@github.com/natelandau/obsidian-metadata pip install obsidian-metadata
``` ```
## Disclaimer ## Important Disclaimer
**Important:** It is strongly recommended that you back up your vault prior to committing changes. This script makes changes directly to the markdown files in your vault. Once the changes are committed, there is no ability to recreate the original information unless you have a backup. Follow the instructions in the script to create a backup of your vault if needed. **It is strongly recommended that you back up your vault prior to committing changes.** This script makes changes directly to the markdown files in your vault. Once the changes are committed, there is no ability to recreate the original information unless you have a backup. Follow the instructions in the script to create a backup of your vault if needed. The author of this script is not responsible for any data loss that may occur. Use at your own risk.
The author of this script is not responsible for any data loss that may occur. Use at your own risk.
## Usage ## Usage
The script provides a menu of available actions. Make as many changes as you require and review them as you go. No changes are made to the Vault until they are explicitly committed. The script provides a menu of available actions. Make as many changes as you require and review them as you go. No changes are made to the Vault until they are explicitly committed.

4
src/obsidian_metadata/cli.py
View File

@@ -82,7 +82,9 @@ def main(
- [code]vault:[/] Create a backup of the Obsidian vault. - [code]vault:[/] Create a backup of the Obsidian vault.
[bold underline]Usage:[/] [bold underline]Usage:[/]
Run [tan]obsidian-metadata[/] from the command line. The script will allow you to make batch updates to metadata in an Obsidian vault. Once you have made your changes, review them prior to committing them to the vault. [tan]Obsidian-metadata[/] allows you to make batch updates to metadata in an Obsidian vault. Once you have made your changes, review them prior to committing them to the vault. The script provides a menu of available actions. Make as many changes as you require and review them as you go. No changes are made to the Vault until they are explicitly committed.
[bold underline]It is strongly recommended that you back up your vault prior to committing changes.[/] This script makes changes directly to the markdown files in your vault. Once the changes are committed, there is no ability to recreate the original information unless you have a backup. Follow the instructions in the script to create a backup of your vault if needed. The author of this script is not responsible for any data loss that may occur. Use at your own risk.
Configuration is specified in a configuration file. On First run, this file will be created at [tan]~/.{0}.env[/]. Any options specified on the command line will override the configuration file. Configuration is specified in a configuration file. On First run, this file will be created at [tan]~/.{0}.env[/]. Any options specified on the command line will override the configuration file.
""" """