smritikosh 0.1.0__tar.gz

smritikosh-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

smritikosh-0.1.0/PKG-INFO

@@ -0,0 +1,242 @@
+Metadata-Version: 2.4
+Name: smritikosh
+Version: 0.1.0
+Summary: Semantic vector search over a codebase
+Author-email: Shantanu Vashishtha <vashishthashantanu3@gmail.com>, Sarvesh Sawant <sarveshdev92@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/learncoder4848/smritikosh
+Project-URL: Repository, https://github.com/learncoder4848/smritikosh
+Project-URL: Issues, https://github.com/learncoder4848/smritikosh/issues
+Keywords: code-search,semantic-search,embeddings,tree-sitter,duckdb,vector-search,rag
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Processing :: Indexing
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1
+Requires-Dist: duckdb>=1.0
+Requires-Dist: pathspec>=1.0
+Requires-Dist: fastembed>=0.3
+Requires-Dist: tree-sitter>=0.25
+Requires-Dist: tree-sitter-language-pack<1.0,>=0.13
+Requires-Dist: truststore>=0.9
+Requires-Dist: watchfiles>=0.21
+Requires-Dist: toons>=0.7
+Dynamic: license-file
+
+# smritikosh
+
+Semantic vector search over source-code repositories. Smritikosh parses source
+files with tree-sitter, identifies meaningful definitions, turns them into
+chunks, embeds those chunks, and stores the vectors in DuckDB.
+
+## Pipeline
+
+```text
+  FileSource            FileRouter
+  (lists + reads)       (extension -> language + strategy)
+        |                    |
+        +--------> discovery <+        select once, per file
+                      |
+                      |  3 gates: excluded dirs -> gitignore -> router
+                      v
+                  SourceFile          path, language, content,
+                      |               has_tags_scm, strategy
+                      v
+        [ file unchanged? ] --yes--> skip file          file_hashes
+                      | no
+                      v
+                   parser              text -> tree-sitter AST
+                      v
+                  extractor            AST -> definition captures (tags.scm)
+                      v
+                   chunker             captures -> chunks (ast|section|regex)
+                      v
+        [ chunk text seen? ] --yes--> reuse vector      content_hash
+                      | no
+                      v
+                  embedder             chunk text -> vector
+                      v
+                   DuckDB              nodes, vectors, file_hashes, memo_cache
+```
+
+Routing happens once, in discovery, and is carried on the `SourceFile`. Later
+stages read `language`, `has_tags_scm`, and `strategy` off that object rather
+than re-deriving them from the path.
+
+Two skip checks make re-indexing cheap. A file whose SHA-256 is unchanged is
+skipped whole. A chunk is keyed by the hash of its own text, so editing one
+function in a file re-embeds only that function's chunk.
+
+The extractor uses packaged `tags.scm` queries for Python, Java, Kotlin,
+TypeScript, JavaScript, Markdown, and JSON. TOML bypasses extraction and uses
+regex chunking. JSON is indexed except for known noise — lockfiles, minified
+bundles, and fixture directories.
+
+## Package structure
+
+- [`smritikosh/indexing`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/indexing)
+  — file router, discovery, parser, extractor, chunker, and pipeline
+  orchestration.
+- [`smritikosh/engine`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/engine)
+  — memoization, tracking, batching, and concurrent pipeline helpers.
+- [`smritikosh/ports`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/ports)
+  — file-source, storage, vector-store, and embedder contracts.
+- [`smritikosh/adapters`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/adapters)
+  — local-filesystem, DuckDB, and sentence-transformer implementations of those
+  contracts.
+- [`smritikosh/queries`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/queries)
+  — packaged tree-sitter tag queries.
+
+The extractor stays under `indexing`: it transforms internal pipeline data
+(`ParsedFile -> list[Capture]`) rather than adapting an external system.
+
+## Installation
+
+```bash
+pip install smritikosh
+```
+
+Or with uv, to get the CLI on your PATH without managing a virtualenv:
+
+```bash
+uv tool install smritikosh
+```
+
+## Development setup
+
+Both **uv** and **Poetry** are supported. uv is recommended for local development
+— it resolves and installs the full dependency tree roughly 5× faster than
+Poetry, thanks to a Rust-based resolver and parallel downloads. (Measured on
+this project: uv locked 94 packages in ~46 s vs Poetry's ~3.5 min.)
+
+### uv (recommended)
+
+```bash
+# Install uv: https://docs.astral.sh/uv/getting-started/installation/
+uv sync                  # install deps + project into .venv
+uv sync --no-install-project  # deps only (skip the editable install)
+```
+
+### Poetry
+
+```bash
+# Requires Poetry >= 2.3
+poetry install           # install deps + project into .venv
+poetry install --no-root # deps only
+```
+
+### Running tests
+
+```bash
+# uv
+uv run pytest
+
+# Poetry / activated venv
+make test
+```
+
+Both tools create a `.venv` in the project root and share the same `Makefile`
+targets. Pass `TOOL=uv` or `TOOL=poetry` to override the default:
+
+```bash
+make install TOOL=uv
+make lock    TOOL=uv    # regenerates uv.lock
+make test               # always uses .venv/bin/python directly
+```
+
+Lock files are not committed. Smritikosh is a library, so installs resolve from
+the version ranges in `pyproject.toml`; `uv.lock` and `poetry.lock` are local
+artifacts that each tool regenerates on demand.
+
+## Read-only exploration CLI
+
+The `explore` commands expose the indexed repository to agents without reading
+the source tree or taking a DuckDB write lock:
+
+```bash
+smritikosh explore tools
+
+smritikosh explore info --db-path smritikosh.duckdb
+
+smritikosh explore search \
+  "where is access control enforced" \
+  "authorization decision logic" \
+  --exclude-path 'tests/%' \
+  --db-path smritikosh.duckdb
+
+smritikosh explore paths permissions \
+  --db-path smritikosh.duckdb
+
+smritikosh explore chunks src/auth/permissions.py \
+  --db-path smritikosh.duckdb
+
+smritikosh explore chunks src/auth/permissions.py \
+  --start-line 40 --end-line 52 \
+  --db-path smritikosh.duckdb
+
+smritikosh explore text is_allowed \
+  --path src/auth/permissions.py \
+  --db-path smritikosh.duckdb
+```
+
+The two calls that answer most questions are `search`, which reports where the
+answer lives, and `chunks PATH --start-line N --end-line M`, which prints that
+source with line numbers. Without a line range `chunks` outlines what a file
+defines rather than printing it; `--full` restores the whole-chunk dump, on
+both commands.
+
+Results come back as [TOON](https://toonformat.dev) — a tabular array that
+declares its columns once and then streams one row per hit:
+
+```text
+[2]{path,start_line,end_line,score,chunk_kind,symbol}:
+  src/auth/permissions.py,59,81,0.434,class,PermissionChecker
+  src/auth/policy.py,176,193,0.436,method,evaluate
+```
+
+That costs roughly half of the equivalent JSON. `--prose` switches any command
+to human-readable output. Source lines are exempt: TOON must quote any value
+containing a colon, so a table of code lines costs more than the numbered text
+it would replace, and `chunks` with a line range always prints numbered text.
+
+Multiple semantic queries are embedded in one model call. Results are
+deduplicated and ranked by each chunk's best score across those queries; a hit
+that mostly repeats the lines of a better-scoring one is dropped. Path, text,
+and chunk commands do not load the embedding model.
+
+`explore tools` returns a machine-readable command manifest and recommended
+workflow. An agent instruction can therefore stay short:
+
+```text
+Use the Smritikosh exploration CLI instead of Grep for code discovery.
+Run `uv run smritikosh explore tools` to discover its commands.
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/learncoder4848/smritikosh/blob/main/CONTRIBUTING.md)
+for commit and PR conventions.
+
+## Credits
+
+Built by [Shantanu Vashishtha](https://github.com/learncoder4848) and
+[Sarvesh Sawant](https://github.com/devsarvesh92).
+
+## Status
+
+Alpha. The pipeline runs end to end — `index` builds an index, `search` and
+`explore` query it, and re-indexing is incremental at both the file and the
+chunk level. Embedding runs locally on CPU through ONNX Runtime, so the only
+network access is a one-time model download.
+
+The CLI surface may still change before 1.0.

smritikosh-0.1.0/README.md

@@ -0,0 +1,207 @@
+# smritikosh
+
+Semantic vector search over source-code repositories. Smritikosh parses source
+files with tree-sitter, identifies meaningful definitions, turns them into
+chunks, embeds those chunks, and stores the vectors in DuckDB.
+
+## Pipeline
+
+```text
+  FileSource            FileRouter
+  (lists + reads)       (extension -> language + strategy)
+        |                    |
+        +--------> discovery <+        select once, per file
+                      |
+                      |  3 gates: excluded dirs -> gitignore -> router
+                      v
+                  SourceFile          path, language, content,
+                      |               has_tags_scm, strategy
+                      v
+        [ file unchanged? ] --yes--> skip file          file_hashes
+                      | no
+                      v
+                   parser              text -> tree-sitter AST
+                      v
+                  extractor            AST -> definition captures (tags.scm)
+                      v
+                   chunker             captures -> chunks (ast|section|regex)
+                      v
+        [ chunk text seen? ] --yes--> reuse vector      content_hash
+                      | no
+                      v
+                  embedder             chunk text -> vector
+                      v
+                   DuckDB              nodes, vectors, file_hashes, memo_cache
+```
+
+Routing happens once, in discovery, and is carried on the `SourceFile`. Later
+stages read `language`, `has_tags_scm`, and `strategy` off that object rather
+than re-deriving them from the path.
+
+Two skip checks make re-indexing cheap. A file whose SHA-256 is unchanged is
+skipped whole. A chunk is keyed by the hash of its own text, so editing one
+function in a file re-embeds only that function's chunk.
+
+The extractor uses packaged `tags.scm` queries for Python, Java, Kotlin,
+TypeScript, JavaScript, Markdown, and JSON. TOML bypasses extraction and uses
+regex chunking. JSON is indexed except for known noise — lockfiles, minified
+bundles, and fixture directories.
+
+## Package structure
+
+- [`smritikosh/indexing`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/indexing)
+  — file router, discovery, parser, extractor, chunker, and pipeline
+  orchestration.
+- [`smritikosh/engine`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/engine)
+  — memoization, tracking, batching, and concurrent pipeline helpers.
+- [`smritikosh/ports`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/ports)
+  — file-source, storage, vector-store, and embedder contracts.
+- [`smritikosh/adapters`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/adapters)
+  — local-filesystem, DuckDB, and sentence-transformer implementations of those
+  contracts.
+- [`smritikosh/queries`](https://github.com/learncoder4848/smritikosh/tree/main/smritikosh/queries)
+  — packaged tree-sitter tag queries.
+
+The extractor stays under `indexing`: it transforms internal pipeline data
+(`ParsedFile -> list[Capture]`) rather than adapting an external system.
+
+## Installation
+
+```bash
+pip install smritikosh
+```
+
+Or with uv, to get the CLI on your PATH without managing a virtualenv:
+
+```bash
+uv tool install smritikosh
+```
+
+## Development setup
+
+Both **uv** and **Poetry** are supported. uv is recommended for local development
+— it resolves and installs the full dependency tree roughly 5× faster than
+Poetry, thanks to a Rust-based resolver and parallel downloads. (Measured on
+this project: uv locked 94 packages in ~46 s vs Poetry's ~3.5 min.)
+
+### uv (recommended)
+
+```bash
+# Install uv: https://docs.astral.sh/uv/getting-started/installation/
+uv sync                  # install deps + project into .venv
+uv sync --no-install-project  # deps only (skip the editable install)
+```
+
+### Poetry
+
+```bash
+# Requires Poetry >= 2.3
+poetry install           # install deps + project into .venv
+poetry install --no-root # deps only
+```
+
+### Running tests
+
+```bash
+# uv
+uv run pytest
+
+# Poetry / activated venv
+make test
+```
+
+Both tools create a `.venv` in the project root and share the same `Makefile`
+targets. Pass `TOOL=uv` or `TOOL=poetry` to override the default:
+
+```bash
+make install TOOL=uv
+make lock    TOOL=uv    # regenerates uv.lock
+make test               # always uses .venv/bin/python directly
+```
+
+Lock files are not committed. Smritikosh is a library, so installs resolve from
+the version ranges in `pyproject.toml`; `uv.lock` and `poetry.lock` are local
+artifacts that each tool regenerates on demand.
+
+## Read-only exploration CLI
+
+The `explore` commands expose the indexed repository to agents without reading
+the source tree or taking a DuckDB write lock:
+
+```bash
+smritikosh explore tools
+
+smritikosh explore info --db-path smritikosh.duckdb
+
+smritikosh explore search \
+  "where is access control enforced" \
+  "authorization decision logic" \
+  --exclude-path 'tests/%' \
+  --db-path smritikosh.duckdb
+
+smritikosh explore paths permissions \
+  --db-path smritikosh.duckdb
+
+smritikosh explore chunks src/auth/permissions.py \
+  --db-path smritikosh.duckdb
+
+smritikosh explore chunks src/auth/permissions.py \
+  --start-line 40 --end-line 52 \
+  --db-path smritikosh.duckdb
+
+smritikosh explore text is_allowed \
+  --path src/auth/permissions.py \
+  --db-path smritikosh.duckdb
+```
+
+The two calls that answer most questions are `search`, which reports where the
+answer lives, and `chunks PATH --start-line N --end-line M`, which prints that
+source with line numbers. Without a line range `chunks` outlines what a file
+defines rather than printing it; `--full` restores the whole-chunk dump, on
+both commands.
+
+Results come back as [TOON](https://toonformat.dev) — a tabular array that
+declares its columns once and then streams one row per hit:
+
+```text
+[2]{path,start_line,end_line,score,chunk_kind,symbol}:
+  src/auth/permissions.py,59,81,0.434,class,PermissionChecker
+  src/auth/policy.py,176,193,0.436,method,evaluate
+```
+
+That costs roughly half of the equivalent JSON. `--prose` switches any command
+to human-readable output. Source lines are exempt: TOON must quote any value
+containing a colon, so a table of code lines costs more than the numbered text
+it would replace, and `chunks` with a line range always prints numbered text.
+
+Multiple semantic queries are embedded in one model call. Results are
+deduplicated and ranked by each chunk's best score across those queries; a hit
+that mostly repeats the lines of a better-scoring one is dropped. Path, text,
+and chunk commands do not load the embedding model.
+
+`explore tools` returns a machine-readable command manifest and recommended
+workflow. An agent instruction can therefore stay short:
+
+```text
+Use the Smritikosh exploration CLI instead of Grep for code discovery.
+Run `uv run smritikosh explore tools` to discover its commands.
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/learncoder4848/smritikosh/blob/main/CONTRIBUTING.md)
+for commit and PR conventions.
+
+## Credits
+
+Built by [Shantanu Vashishtha](https://github.com/learncoder4848) and
+[Sarvesh Sawant](https://github.com/devsarvesh92).
+
+## Status
+
+Alpha. The pipeline runs end to end — `index` builds an index, `search` and
+`explore` query it, and re-indexing is incremental at both the file and the
+chunk level. Embedding runs locally on CPU through ONNX Runtime, so the only
+network access is a one-time model download.
+
+The CLI surface may still change before 1.0.