Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Yakitrak/obsidian-cli
Interact with Obsidian in the terminal. Open, search, create, update, move and delete notes!
https://github.com/Yakitrak/obsidian-cli
bash cli go golang obsidian zsh
Last synced: 2 months ago
JSON representation
Interact with Obsidian in the terminal. Open, search, create, update, move and delete notes!
- Host: GitHub
- URL: https://github.com/Yakitrak/obsidian-cli
- Owner: Yakitrak
- License: mit
- Created: 2023-01-14T14:31:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-13T17:07:41.000Z (3 months ago)
- Last Synced: 2024-07-14T17:47:30.476Z (3 months ago)
- Topics: bash, cli, go, golang, obsidian, zsh
- Language: Go
- Homepage: https://yakitrak.github.io/obsidian-cli-docs
- Size: 3.13 MB
- Stars: 334
- Watchers: 4
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-cli-apps - obs - Interact with your Obsidian vault. (Productivity / Note Taking and Lists)
- project-awesome - Yakitrak/obsidian-cli - Interact with Obsidian in the terminal. Open, search, create, update, move and delete notes! (Go)
- jimsghstars - Yakitrak/obsidian-cli - Interact with Obsidian in the terminal. Open, search, create, update, move and delete notes! (Go)
- fucking-awesome-cli-apps - obs - Interact with your Obsidian vault. (Productivity / Note Taking and Lists)
README
# Obsidian CLI
---
---
## [Installation and Usage Manual](https://yakitrak.github.io/obsidian-cli-docs/)
---
## Description
Obsidian is a powerful and extensible knowledge base application
that works on top of your local folder of plain text notes. This CLI tool (written in Go) will let you interact with the application using the terminal. You are currently able to open, search, move, create, update and delete notes.
---
## Install
### Windows
You will need to have [Scoop](https://scoop.sh/) installed. On powershell run:
```
scoop bucket add scoop-yakitrak https://github.com/yakitrak/scoop-yakitrak.git
```
```
scoop install obsidian-cli
```
For full installation instructions, see [Windows installation manual](https://yakitrak.github.io/obsidian-cli-docs/docs/install/windows).
### Mac and Linux
You will need to have [Homebrew](https://brew.sh/) installed.
```Bash
brew tap yakitrak/yakitrak
```
```Bash
brew install yakitrak/yakitrak/obsidian-cli
```
For full installation instructions, see [Mac and Linux manual](https://yakitrak.github.io/obsidian-cli-docs/docs/install/mac-and-linux).
## Usage
### Help
```bash
# See All command instructions
obsidian-cli --help
```
### Set Default Vault
Defines default vault for future usage. If not set, pass `--vault` flag for other commands. You don't provide the path to vault here, just the name.
```bash
obsidian-cli set-default "{vault-name}"
```
Note: `open` and other commands in `obsidian-cli` use this vault's base directory as the working directory, not the current working directory of your terminal.
### Print Default Vault
Prints default vault and path. Please set this with `set-default` command if not set.
```bash
obsidian-cli print-default
```
### Open Note
Open given note name in Obsidian. Note can also be an absolute path from top level of vault.
```bash
# Opens note in obsidian
obsidian-cli open "{note-name}"
# Opens note in specified obsidian
obsidian-cli open "{note-name}" --vault "{vault-name}"
```
### Search Note
Opens obsidian search tab with given search text
```bash
# Searches in default obsidian
obsidian-cli search "{search-text}"
# Searches in specified obsidian
obsidian-cli search "{search-text}" --vault "{vault-name}"
```
### Create / Update Note
Creates note (can also be a path with name) in vault. By default, if the note exists, it will create another note but passing `--overwrite` or `--append` can be used to edit the named note.
```bash
# Creates empty note in default obsidian and opens it
obsidian-cli create "{note-name}"
# Creates empty note in given obsidian and opens it
obsidian-cli create "{note-name}" --vault "{vault-name}"
# Creates note in default obsidian with content
obsidian-cli create "{note-name}" --content "abcde"
# Creates note in default obsidian with content - overwrite existing note
obsidian-cli create "{note-name}" --content "abcde" --overwrite
# Creates note in default obsidian with content - append existing note
obsidian-cli create "{note-name}" --content "abcde" --append
# Creates note and opens it
obsidian-cli create "{note-name}" --content "abcde" --open
```
### Move / Rename Note
Moves a given note(path from top level of vault) with new name given (top level of vault). If given same path but different name then its treated as a rename. All links inside vault are updated to match new name.
```bash
# Renames a note in default obsidian
obsidian-cli move "{current-note-path}" "{new-note-path}"
# Renames a note and given obsidian
obsidian-cli move "{current-note-path}" "{new-note-path}" --vault "{vault-name}"
# Renames a note in default obsidian and opens it
obsidian-cli move "{current-note-path}" "{new-note-path}" --open
```
### Delete Note
Deletes a given note (path from top level of vault).
```bash
# Renames a note in default obsidian
obsidian-cli delete "{note-path}"
# Renames a note in given obsidian
obsidian-cli delete "{note-path}" --vault "{vault-name}"
```
## Contribution
Fork the project, add your feature or fix and submit a pull request. You can also open an [issue](https://github.com/yakitrak/obsidian-cli/issues/new/choose) to report a bug or request a feature.
## License
Available under [MIT License](./LICENSE)