{"id":17984431,"url":"https://github.com/adoyle-h/ithoughts-search","last_synced_at":"2025-03-25T20:32:05.397Z","repository":{"id":149887474,"uuid":"104576961","full_name":"adoyle-h/iThoughts-Search","owner":"adoyle-h","description":"A bash command for searching content from multi iThoughts (.itmz) files","archived":false,"fork":false,"pushed_at":"2021-10-20T07:25:03.000Z","size":20,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-20T17:51:37.867Z","etag":null,"topics":["cli","ithoughts","itmz"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/adoyle-h.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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},"funding":{"patreon":"adoyle_h","liberapay":"adoyle","custom":["https://media.githubusercontent.com/media/adoyle-h/_imgs/master/sponsor.png"]}},"created_at":"2017-09-23T15:16:16.000Z","updated_at":"2021-10-20T07:24:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"40fdcb7b-a4fb-4ded-9e15-a1bdacbf385c","html_url":"https://github.com/adoyle-h/iThoughts-Search","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoyle-h%2FiThoughts-Search","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoyle-h%2FiThoughts-Search/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoyle-h%2FiThoughts-Search/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adoyle-h%2FiThoughts-Search/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adoyle-h","download_url":"https://codeload.github.com/adoyle-h/iThoughts-Search/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245540345,"owners_count":20632144,"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":["cli","ithoughts","itmz"],"created_at":"2024-10-29T18:21:21.843Z","updated_at":"2025-03-25T20:32:05.351Z","avatar_url":"https://github.com/adoyle-h.png","language":"Shell","funding_links":["https://patreon.com/adoyle_h","https://liberapay.com/adoyle","https://media.githubusercontent.com/media/adoyle-h/_imgs/master/sponsor.png"],"categories":[],"sub_categories":[],"readme":"# iThoughts-Search\n\nA bash command for searching content from multi iThoughts (.itmz) files.\n\n## TOC\n\n\u003c!-- MarkdownTOC GFM --\u003e\n\n- [Dependencies](#dependencies)\n- [Install](#install)\n- [Usage](#usage)\n- [Environment Variables](#environment-variables)\n- [Example](#example)\n- [Auto-Completion](#auto-completion)\n- [Versioning](#versioning)\n- [Copyright and License](#copyright-and-license)\n\n\u003c!-- /MarkdownTOC --\u003e\n\n\n## Dependencies\n\n- GNU bash, 4.4.12(1)-release or above\n- .itmz files must be created by iThoughts 4.12 or above\n- [`ag`](https://github.com/ggreer/the_silver_searcher)\n- `realpath`, which installed by `brew install coreutils`\n- `cksum`, system default\n\n## Install\n\n```sh\n# git clone the source code\nsrc_dir=\ngit clone https://github.com/adoyle-h/iThoughts-Search \"$src_dir\"\n# ITMZ_DIR: all your .itmz files should be put under this path.\nexport ITMZ_DIR=\n# iThoughts-Search caches and logs will be put under the ITMZ_HOME\nexport ITMZ_HOME=${ITMZ_HOME:-$HOME/.itmz}\n\ncat \u003e\u003e ~/.bashrc \u003c\u003cEOF\nexport ITMZ_DIR=$ITMZ_DIR\nexport ITMZ_HOME=$ITMZ_HOME\nEOF\n\nln -s \"$src_dir/bin/itmz-search\" /usr/local/bin/itmz\n```\n\n## Usage\n\n- `itmz` or `itmz -h` to display command helps\n- `itmz \u003cpattern\u003e [dir]` to search contents with `ag` from all `.itmz` files stored in specific directory.\n  - The search pattern is case-insensitive\n  - If `dir` is omit, it will search all `.imtz` files in `$ITMZ_DIR`. Otherwise, it will search files in `$ITMZ_DIR/$dir`.\n  - Each search will generator cache to speed up for next search in ITMZ_REF_DIR which is `$ITMZ_HOME/refs`.\n  - Each search will auto-update cache if the file has been modified.\n  - If you really worry about the cache-refreshing, use `itmz --cache-clean` to clean all caches.\n- `itmz -l \u003cpattern\u003e [dir]` to search matched filepaths with `ag` from all .itmz files stored in specific directory.\n\n## Environment Variables\n\n```sh\n# all your .itmz files should be put under this path.\nITMZ_DIR=${ITMZ_DIR:?}\n# iThoughts-Search caches and logs will be put under the ITMZ_HOME\nITMZ_HOME=${ITMZ_HOME:-$HOME/itmz}\n```\n\n## Example\n\n## Auto-Completion\n\n```sh\n# For bash\nsource \u003c(itmz --completion)\n\n# or add it to your .bashrc to make it persist\necho \"source \u003c(itmz --completion)\" \u003e\u003e ~/.bashrc \u0026\u0026 source ~/.bashrc\n```\n\n## Versioning\n\nThe versioning follows the rules of SemVer 2.0.0.\n\n**Attentions**: anything may have **BREAKING CHANGES** at **ANY TIME** when major version is zero (0.y.z), which is for initial development and the public API should be considered unstable.\n\nFor more information on SemVer, please visit http://semver.org/.\n\n\n## Copyright and License\n\nCopyright (c) 2017-2021 ADoyle. The project is licensed under the **Apache License Version 2.0**.\n\nSee the [LICENSE][] file for the specific language governing permissions and limitations under the License.\n\nSee the [NOTICE][] file distributed with this work for additional information regarding copyright ownership.\n\n\n\u003c!-- Links --\u003e\n\n[LICENSE]: ./LICENSE\n[NOTICE]: ./NOTICE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadoyle-h%2Fithoughts-search","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadoyle-h%2Fithoughts-search","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadoyle-h%2Fithoughts-search/lists"}