{"id":13530872,"url":"https://github.com/Yakitrak/obsidian-cli","last_synced_at":"2025-04-01T19:30:43.471Z","repository":{"id":154439374,"uuid":"588934663","full_name":"Yakitrak/obsidian-cli","owner":"Yakitrak","description":"Interact with Obsidian in the terminal. Open, search, create, update, move, delete and print notes!","archived":false,"fork":false,"pushed_at":"2024-12-27T22:35:36.000Z","size":5988,"stargazers_count":494,"open_issues_count":1,"forks_count":20,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-01T08:29:41.808Z","etag":null,"topics":["bash","cli","go","golang","obsidian","zsh"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Yakitrak.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["Yakitrak"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":null,"thanks_dev":null,"custom":null}},"created_at":"2023-01-14T14:31:00.000Z","updated_at":"2025-03-30T13:02:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"ca24df9f-ab3c-4365-b9a8-200357cc04c8","html_url":"https://github.com/Yakitrak/obsidian-cli","commit_stats":{"total_commits":23,"total_committers":4,"mean_commits":5.75,"dds":"0.21739130434782605","last_synced_commit":"848cb3a4c1559f5f846adaf1f301891b2f9fa426"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yakitrak%2Fobsidian-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yakitrak%2Fobsidian-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yakitrak%2Fobsidian-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Yakitrak%2Fobsidian-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Yakitrak","download_url":"https://codeload.github.com/Yakitrak/obsidian-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246700088,"owners_count":20819824,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","cli","go","golang","obsidian","zsh"],"created_at":"2024-08-01T07:00:56.831Z","updated_at":"2025-04-01T19:30:43.462Z","avatar_url":"https://github.com/Yakitrak.png","language":"Go","readme":"# Obsidian CLI\n\n---\n![obsidian-cli Usage](./docs/usage.png)\n---\n\n## Description\n\nObsidian is a powerful and extensible knowledge base application \nthat 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.\n\n---\n\n## Install\n\n### Windows\nYou will need to have [Scoop](https://scoop.sh/) installed. On powershell run:\n```\nscoop bucket add scoop-yakitrak https://github.com/yakitrak/scoop-yakitrak.git\n```\n\n```\nscoop install obsidian-cli\n```\n\n### Mac and Linux\n\nYou will need to have [Homebrew](https://brew.sh/) installed.\n\n```Bash\nbrew tap yakitrak/yakitrak\n```\n\n```Bash\nbrew install yakitrak/yakitrak/obsidian-cli\n```\n\nFor full installation instructions, see [Mac and Linux manual](https://yakitrak.github.io/obsidian-cli-docs/docs/install/mac-and-linux).\n\n## Usage\n\n### Help\n\n```bash\n# See All command instructions\nobsidian-cli --help\n```\n\n### Set Default Vault\n\nDefines 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.\n\n```bash\nobsidian-cli set-default \"{vault-name}\"\n```\n\nNote: `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.\n\n### Print Default Vault\n\nPrints default vault and path. Please set this with `set-default` command if not set.\n\n```bash\nobsidian-cli print-default\n```\n\n### Open Note\n\nOpen given note name in Obsidian. Note can also be an absolute path from top level of vault.\n\n```bash\n# Opens note in obsidian vault\nobsidian-cli open \"{note-name}\"\n\n# Opens note in specified obsidian vault\nobsidian-cli open \"{note-name}\" --vault \"{vault-name}\"\n\n```\n\n### Daily Note\n\nOpen daily note in Obsidian. It will create one (using template) if one does not exist.\n\n```bash\n# Creates / opens daily note in obsidian vault\nobsidian-cli daily\n\n# Creates / opens daily note in specified obsidian vault\nobsidian-cli dauly --vault \"{vault-name}\"\n\n```\n\n### Search Note\n\nStarts a fuzzy search displaying notes in the terminal from the vault. You can hit enter on a note to open that in Obsidian\n\n```bash\n# Searches in default obsidian vault\nobsidian-cli search \n\n# Searches in specified obsidian vault\nobsidian-cli search --vault \"{vault-name}\"\n\n```\n\n### Print Note\n\nPrints the contents of given note name in Obsidian.\n\n```bash\n# Prints note in default vault\nobsidian-cli print \"{note-name}\"\n\n# Prints note in specified obsidian\nobsidian-cli print \"{note-name}\" --vault \"{vault-name}\"\n\n```\n\n### Create / Update Note\n\nCreates 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.\n\n```bash\n# Creates empty note in default obsidian and opens it\nobsidian-cli create \"{note-name}\"\n\n# Creates empty note in given obsidian and opens it\nobsidian-cli create \"{note-name}\"  --vault \"{vault-name}\"\n\n# Creates note in default obsidian with content\nobsidian-cli create \"{note-name}\" --content \"abcde\"\n\n# Creates note in default obsidian with content - overwrite existing note\nobsidian-cli create \"{note-name}\" --content \"abcde\" --overwrite\n\n# Creates note in default obsidian with content - append existing note\nobsidian-cli create \"{note-name}\" --content \"abcde\" --append\n\n# Creates note and opens it\nobsidian-cli create \"{note-name}\" --content \"abcde\" --open\n\n```\n\n### Move / Rename Note\n\nMoves 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.\n\n```bash\n# Renames a note in default obsidian\nobsidian-cli move \"{current-note-path}\" \"{new-note-path}\"\n\n# Renames a note and given obsidian\nobsidian-cli move \"{current-note-path}\" \"{new-note-path}\" --vault \"{vault-name}\"\n\n# Renames a note in default obsidian and opens it\nobsidian-cli move \"{current-note-path}\" \"{new-note-path}\" --open\n```\n\n### Delete Note\n\nDeletes a given note (path from top level of vault).\n\n```bash\n# Renames a note in default obsidian\nobsidian-cli delete \"{note-path}\" \n\n# Renames a note in given obsidian\nobsidian-cli delete \"{note-path}\" --vault \"{vault-name}\"\n```\n\n## Contribution\nFork 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.\n\n## License\nAvailable under [MIT License](./LICENSE)\n","funding_links":["https://github.com/sponsors/Yakitrak"],"categories":["Productivity","Go","[](#table-of-contents) Table of contents"],"sub_categories":["Note Taking and Lists","[](#netflix)Netflix"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYakitrak%2Fobsidian-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FYakitrak%2Fobsidian-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FYakitrak%2Fobsidian-cli/lists"}