{"id":49639878,"url":"https://github.com/michaeloboyle/obsidian_api","last_synced_at":"2026-05-05T18:49:46.989Z","repository":{"id":253153703,"uuid":"842612342","full_name":"michaeloboyle/obsidian_api","owner":"michaeloboyle","description":"ObsidianAPI is a Ruby gem that allows developers to interact with their Obsidian vaults directly from Ruby. With this gem, you can manage Markdown files, handle metadata, and automate tasks within your vaults programmatically.","archived":false,"fork":false,"pushed_at":"2024-10-28T18:39:30.000Z","size":35,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-05-05T18:49:35.215Z","etag":null,"topics":["obsidian-md"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/michaeloboyle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2024-08-14T17:48:04.000Z","updated_at":"2024-09-16T14:23:00.000Z","dependencies_parsed_at":"2024-08-14T20:43:50.622Z","dependency_job_id":null,"html_url":"https://github.com/michaeloboyle/obsidian_api","commit_stats":null,"previous_names":["michaeloboyle/obsidian_api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/michaeloboyle/obsidian_api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeloboyle%2Fobsidian_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeloboyle%2Fobsidian_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeloboyle%2Fobsidian_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeloboyle%2Fobsidian_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaeloboyle","download_url":"https://codeload.github.com/michaeloboyle/obsidian_api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaeloboyle%2Fobsidian_api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32663438,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-05T11:29:49.557Z","status":"ssl_error","status_checked_at":"2026-05-05T11:29:48.587Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["obsidian-md"],"created_at":"2026-05-05T18:49:46.126Z","updated_at":"2026-05-05T18:49:46.978Z","avatar_url":"https://github.com/michaeloboyle.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ObsidianAPI Gem\n\n[![Gem Version](https://badge.fury.io/rb/obsidian_api.svg)](https://badge.fury.io/rb/obsidian_api_gem)\n[![Build Status](https://travis-ci.org/your_username/obsidian_api_gem.svg?branch=main)](https://travis-ci.org/your_username/obsidian_api_gem)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n`ObsidianAPI` is a Ruby gem that allows developers to interact with their Obsidian vaults directly from Ruby. With this gem, you can manage Markdown files, handle metadata, and automate tasks within your vaults programmatically.\n\n## Features\n\n- **List Markdown Files**: Retrieve a list of all Markdown files within an Obsidian vault.\n- **Read File Content**: Read the content of a specific Markdown file.\n- **Write to Files**: Modify the content of existing Markdown files or create new ones.\n- **Delete Files**: Safely delete files from your vault.\n- **Tag Management**: Add and remove tags from notes.\n- **Event Handling**: Register and handle events such as file creation, modification, and deletion.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'obsidian_api'\n```\n\nAnd then execute:\n\n```bash\nbundle install\n```\n\nOr install it yourself as:\n\n```bash\ngem install obsidian_api\n```\n\n## Usage\n\n### Initializing a Vault\n\nTo start interacting with your Obsidian vault, initialize the `Vault` class with the path to your vault:\n\n```ruby\nrequire 'obsidian_api/vault'\n\nvault = ObsidianAPI::Vault.new('/path/to/your/obsidian/vault')\n```\n\n### Listing Files\n\nYou can list all Markdown files in your vault:\n\n```ruby\nfiles = vault.list_files\nfiles.each { |file| puts file }\n```\n\n### Reading a File\n\nTo read the content of a specific file:\n\n```ruby\ncontent = vault.read('note1.md')\nputs content\n```\n\n### Writing to a File\n\nTo write content to a new or existing file:\n\n```ruby\nvault.write('note2.md', \"# Note 2\\nThis is the second note.\")\n```\n\n### Deleting a File\n\nTo delete a file from your vault:\n\n```ruby\nvault.delete('note2.md')\n```\n\n### Working with Notes\n\nThe `Note` class provides more specialized methods for handling Markdown files:\n\n```ruby\nrequire 'obsidian_api/note'\n\nnote = ObsidianAPI::Note.new(vault, 'note1.md')\n\n# Get the content of the note\nputs note.content\n\n# Add a tag to the note\nnote.add_tag('important')\n\n# Remove a tag from the note\nnote.remove_tag('important')\n```\n\n### Event Handling\n\nYou can also register event handlers to listen for changes within your vault:\n\n```ruby\nrequire 'obsidian_api/event_handler'\n\nevent_handler = ObsidianAPI::EventHandler.new('/path/to/your/obsidian/vault')\n\nevent_handler.start\n```\n\n## Development\n\nAfter checking out the repo, run `bundle install` to install dependencies. Then, run `rspec` to run the tests.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [RubyGems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/your_username/obsidian_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/your_username/obsidian_api_gem/blob/main/CODE_OF_CONDUCT.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the ObsidianAPI project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [code of conduct](https://github.com/your_username/obsidian_api/blob/main/CODE_OF_CONDUCT.md).\n\n---\n\nThis README provides a comprehensive overview of the `ObsidianAPI` gem, including installation instructions, basic usage examples, and information on contributing to the project. Be sure to replace placeholder URLs with the actual links to your GitHub repository and other relevant resources.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaeloboyle%2Fobsidian_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaeloboyle%2Fobsidian_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaeloboyle%2Fobsidian_api/lists"}