{"id":18392180,"url":"https://github.com/lethalbit/bookwurm","last_synced_at":"2026-02-24T15:36:33.693Z","repository":{"id":230232428,"uuid":"778774033","full_name":"lethalbit/bookwurm","owner":"lethalbit","description":"dead simple document index and search, nothing fancy","archived":false,"fork":false,"pushed_at":"2024-03-28T16:40:19.000Z","size":21,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-07T03:35:24.320Z","etag":null,"topics":["document-indexing","document-search"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lethalbit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-03-28T11:28:03.000Z","updated_at":"2024-07-24T21:37:26.000Z","dependencies_parsed_at":"2024-03-28T15:29:30.190Z","dependency_job_id":"a8c82181-67df-4274-8557-b61e3e95c891","html_url":"https://github.com/lethalbit/bookwurm","commit_stats":null,"previous_names":["lethalbit/bookwurm"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/lethalbit/bookwurm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lethalbit%2Fbookwurm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lethalbit%2Fbookwurm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lethalbit%2Fbookwurm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lethalbit%2Fbookwurm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lethalbit","download_url":"https://codeload.github.com/lethalbit/bookwurm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lethalbit%2Fbookwurm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29788257,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-24T10:45:18.109Z","status":"ssl_error","status_checked_at":"2026-02-24T10:45:09.911Z","response_time":75,"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":["document-indexing","document-search"],"created_at":"2024-11-06T01:54:35.186Z","updated_at":"2026-02-24T15:36:33.666Z","avatar_url":"https://github.com/lethalbit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bookwurm\n\n\u003e [!CAUTION]\n\u003e This is a very young, and very unstable project that was built for personal use.\n\u003e The index schema is not stable, nor how things are indexed, or anything else,\n\u003e if you **really** want to use this, do so with caution.\n\nbookwurm is a super simple document index and search interface. It was built for my needs and my needs alone, but everyone is more than welcome to use it if they so see fit.\n\n\nbookwurm is backed by a [meilisearch] instance for the actual maintaining and searching of the index, the instance doesn't need to stay up, it only needs to be alive when bookwurm is trying to search the index or populate the index.\n\n## Installing\n\nTo install, you can just use [pipx] to do most of the heavy lifting.\n\n```\n$ pipx install git+https://github.com/lethalbit/bookwurm\n```\n\nOnce that's done, make sure you have a local [meilisearch] somewhere, we just need the authorization key, host and port to dump in the bookwurm config.\n\n\nThe fastest way to get a bookwurm config is to just run bookwurm once, it'll then dump the default config to `$HOME/.config/bookwurm/config.json`. So, you can just run `bookwurm stats`, it'll fail, but that's fine, we have a config file now.\n\n\nNext, open the configuration file, and make sure the `host`, `port`, and `key` in the `meilisearch` section are set correctly, it should look something like this:\n\n```json\n{\n    \"index_directories\": [],\n    \"meilisearch\": {\n        \"host\": \"http://127.0.0.1\",\n        \"port\": \"7700\",\n        \"key\": \"jVvpzuSrbgpLREZTmql-Rn8SpLwW7fLs0DwC8W8jMVs\",\n        \"exec\": \"$HOME/.cache/bookwurm/meilisearch\",\n        \"db_dir\": \"$HOME/.local/share/bookwurm/data.ms\",\n        \"dump_dir\": \"$HOME/.local/share/bookwurm/dumps\"\n    }\n}\n```\n\nYou can safely ignore the last three options, they're not implemented yet.\n\n\n## Usage\n\nPrior to usage, make sure the configured [meilisearch] instance is running somewhere, you can shut it down when you're done with bookwurm.\n\nTo index a directory (this will take a loooong time):\n\n```\n$ python -m bookwurm index [-j NUM_THREADS] \u003c/path/to/directory\u003e\n```\n\nTo search index:\n\n```\n$ python -m bookwum search [-l RESULT_LIMIT] \u003cquery\u003e\n```\n\n## License\n\nbookwurm licensed under the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) and can be found in [LICENSE.software](https://github.com/lethalbit/bookwurm/tree/main/LICENSE.software).\n\n\n[meilisearch]: https://github.com/meilisearch/meilisearch\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flethalbit%2Fbookwurm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flethalbit%2Fbookwurm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flethalbit%2Fbookwurm/lists"}