{"id":13631454,"url":"https://github.com/eugeneyan/obsidian-copilot","last_synced_at":"2025-04-04T15:10:09.613Z","repository":{"id":174822939,"uuid":"652065806","full_name":"eugeneyan/obsidian-copilot","owner":"eugeneyan","description":"🤖 A prototype assistant for writing and thinking","archived":false,"fork":false,"pushed_at":"2024-06-30T17:57:49.000Z","size":507,"stargazers_count":529,"open_issues_count":1,"forks_count":40,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-03-28T14:07:40.495Z","etag":null,"topics":["assistant","generative-ai","large-language-models","llm","obsidian-plugin","retrieval-augmented-generation"],"latest_commit_sha":null,"homepage":"https://eugeneyan.com/writing/obsidian-copilot/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eugeneyan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2023-06-11T01:17:43.000Z","updated_at":"2025-03-23T19:40:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"f81230e7-c469-4b05-882a-b26ee050b93f","html_url":"https://github.com/eugeneyan/obsidian-copilot","commit_stats":null,"previous_names":["eugeneyan/obsidian-copilot"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugeneyan%2Fobsidian-copilot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugeneyan%2Fobsidian-copilot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugeneyan%2Fobsidian-copilot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eugeneyan%2Fobsidian-copilot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eugeneyan","download_url":"https://codeload.github.com/eugeneyan/obsidian-copilot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247198463,"owners_count":20900080,"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":["assistant","generative-ai","large-language-models","llm","obsidian-plugin","retrieval-augmented-generation"],"created_at":"2024-08-01T22:02:26.163Z","updated_at":"2025-04-04T15:10:09.592Z","avatar_url":"https://github.com/eugeneyan.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# Obsidian-copilot\n\n## How would a copilot for writing and thinking look like?\n\nHere's a possible implementation: You write a section header and the copilot retrieves relevant notes \u0026 docs to draft that section for you. This pattern of [retrieval-augmented generation](https://arxiv.org/abs/2005.11401) can also be extended to other use cases. Here's an example where the copilot helps you reflect on your week based on your daily journal entries.\n\nhttps://github.com/eugeneyan/obsidian-copilot/assets/6831355/70ef5412-74a4-449d-9d37-6668ae7ed36a\n\nCurrently, copilot helps you:\n- Draft sections based on your notes\n- Reflect on your week based on your daily journal entries\n\n![](assets/features.png)\n\nMore technical details on how it works here: [Obsidian-Copilot: A Prototype Assistant for Writing \u0026 Thinking](https://eugeneyan.com/writing/obsidian-copilot/)\n\n## Quick start\n\nClone and update the path to your obsidian-vault and huggingface hub cache\n\n```\ngit clone https://github.com/eugeneyan/obsidian-copilot.git\n```\n\nUpdate your `~/.bashrc` or `~/.zshrc` with the `OBSIDIAN_PATH` and `TRANSFORMER_CACHE` paths and then source it.\nNote: the trailing slash is important.\n\n```\n\nexport OBSIDIAN_PATH=/path/to/obsidian-vault/\nexport TRANSFORMER_CACHE=/path/to/.cache/huggingface/hub\n```\n\nIf you don't already have a huggingface hub cache, you can create the directory with `mkdir -p $TRANSFORMER_CACHE`\n\nBuild the OpenSearch and semantic indices\n```\n# Build the docker image\nmake build\n\n# Start the opensearch container and wait for it to start.\n# You should see something like this: [c6587bf83572] Node 'c6587bf83572' initialized\nmake opensearch\n\n# In ANOTHER terminal, build your artifacts (this can take a while)\nmake build-artifacts\n```\n\nRunning the retrieval app\n```\n# First, stop the opensearch container (CTRL + C). Then, start the retrieval app.\n# You should see this: Uvicorn running on http://0.0.0.0:8000\nmake run\n```\n\nInstall the copilot-plugin, enable it in community plugin settings, and update the API key in copilot\n\n```\nmake install-plugin\n```\n\n![](assets/enable-copilot.png)\n![](assets/provide-api-key.png)\n\n## How does it work?\n\nAt a high level, when you type a section header, it'll:\n- Retrieve relevant documents/snippets from the your obsidian vault via:\n    - [Keyword search](https://github.com/eugeneyan/obsidian-copilot/blob/main/src/prep/build_opensearch_index.py#L141) (opensearch)\n    - [Semantic search](https://github.com/eugeneyan/obsidian-copilot/blob/main/src/prep/build_semantic_index.py#L119) (semantic retrieval)\n- The retrieved context is then used to generate paragraphs for the section\n- It is also displayed in a new tab for info\n\n## Contributing\n\nTo install the pre-commit hooks, run `pip install pre-commit \u0026\u0026 pre-commit install` in the root of the repository.\n\n## TODOs\n\n- [ ] Add support for using anthrophic claude (100k context)\n- [ ] Assess sending in entire documents instead of chunks\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feugeneyan%2Fobsidian-copilot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feugeneyan%2Fobsidian-copilot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feugeneyan%2Fobsidian-copilot/lists"}