obs - the Obsidian CLI
⚡️ Connecting your second brain to the termainl - blazing fast ⚡️
## Note 🚧
- `obs` is under active development and currently only support MacOS, please report any issue while using!
## Features
- Fast & easy access to vaults from terminal in seconds
- Backup your vault to remote git effortlessly
- Flat learning curve without the need to memorize complciated commands
- Automatically fetch vault list from Obsidian, no extra config needed
## Usage
- `obs` : open up a menu for choosing actions and vault to interact with
- `goto` : goto vault
- `open` : open vault
- `backup` : backup vault
- `obs --goto ` : `cd` to the directory of vault ``
- `obs --open ` : open the vault `` in Obsidian
- `obs --help` : show help
## Getting Started
1. Clone this repo
2. Install `obs`
```bash
cargo install --path .
```
3. Put this in your `.zshrc` (or equivalent)
```bash
obs() {
local result=$(command obs "$@")
[ -n "$result" ] && cd -- "$result"
}
```
4. `obs`
## Roadmap
- [x] add clap and `-h`
- [x] imporve `README`
- [x] add `obsidian-git` support
- [ ] improve error handling
## License
[MIT @ 2023](LICENSE): Distributed under the MIT License.