@angri450/zvec-grep 0.2.2

package/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.

package/README.md

@@ -0,0 +1,319 @@
+<p align="right">
+  English | <a href="./README_CN.md">中文</a>
+</p>
+
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="./.github/assets/zg-logo-dark.svg">
+    <img src="./.github/assets/zg-logo.svg" width="150" alt="zg logo" />
+  </picture>
+  <p><strong>Know the words—or don’t. Just zg.</strong></p>
+  <p>The local-first search layer for humans and agents.</p>
+
+  <p>
+    <a href="https://www.npmjs.com/package/@zvec/zvec-grep"><img src="https://img.shields.io/npm/v/@zvec/zvec-grep.svg" alt="npm version" /></a>
+    <a href="https://github.com/zvec-ai/zvec-grep/actions/workflows/ci.yml"><img src="https://github.com/zvec-ai/zvec-grep/actions/workflows/ci.yml/badge.svg" alt="CI" /></a>
+    <a href="./LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="Apache 2.0 license" /></a>
+    <img src="https://img.shields.io/badge/node-%3E%3D22-blue.svg" alt="Node.js 22 or newer" />
+  </p>
+
+  <p>
+    <a href="https://trendshift.io/repositories/200612?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-200612" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/200612/daily?language=TypeScript" alt="zvec-ai/zvec-grep | Trendshift TypeScript daily ranking" width="250" height="55" /></a>
+    <a href="https://trendshift.io/repositories/200612?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-200612" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/200612/daily" alt="zvec-ai/zvec-grep | Trendshift all-language daily ranking" width="250" height="55" /></a>
+  </p>
+
+  <p>
+    <a href="#tour">🎬 <strong>Tour</strong></a> |
+    <a href="#features">💫 <strong>Features</strong></a> |
+    <a href="#try-it-yourself">🚀 <strong>Try it yourself</strong></a> |
+    <a href="./docs/README.md">📚 <strong>Docs</strong></a> |
+    <a href="#benchmarks">📊 <strong>Benchmarks</strong></a> |
+    <a href="#community">🤝 <strong>Community</strong></a>
+  </p>
+</div>
+
+**zg** (**z**vec-**g**rep), powered by [zvec](https://github.com/alibaba/zvec),
+unifies ripgrep, BM25, and vector search behind
+[one local-first interface](./docs/05-architecture.md). Use it directly from the
+terminal, or let your agent use it for you.
+
+<a id="tour"></a>
+
+## 🎬 See it in action
+
+<div align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="./.github/assets/zvec-grep-tour-dark.gif">
+    <img src="./.github/assets/zvec-grep-tour.gif" width="1000" alt="Install the agent integration, index a workspace, and let the agent search it with zvec-grep" />
+  </picture>
+</div>
+
+<a id="features"></a>
+
+## 💫 Why zg?
+
+- **Ready for humans and agents** — install once, index once, then use the same
+  workspace from the CLI or your agent on macOS, Linux, and Windows.
+- **Search beyond keywords** — discover by meaning, rank by relevance, then
+  verify with exact text or regex when needed.
+- **Multi-format search** — search source code, documents, and structured data
+  while preserving useful structure and source locations.
+- **Less searching, less context** — ranked, source-linked results surface the
+  right evidence with fewer tool calls, fewer tokens, and less noise.
+- **Local by default** — files, indexes, and local models stay on your machine;
+  remote embeddings receive data only with your permission.
+
+<a id="try-it-yourself"></a>
+
+## 🚀 Try it yourself
+
+### 1. Set up a sample bookshelf
+
+```bash
+# Requires Node.js 22 or newer.
+npm install -g @zvec/zvec-grep
+
+mkdir zg-mystery && cd zg-mystery
+curl --retry 3 --retry-all-errors --progress-bar -fL \
+  -o alice-in-wonderland.txt https://raw.githubusercontent.com/GITenberg/Alice-s-Adventures-in-Wonderland_11/master/11.txt \
+  -o sherlock-holmes.txt https://raw.githubusercontent.com/GITenberg/The-Memoirs-of-Sherlock-Holmes_834/master/834.txt
+
+zg index --embedding local/potion-retrieval-32m
+```
+
+> [!NOTE]
+> The index is stored in `.zvec-grep/` under the indexed project root.
+
+> [!TIP]
+> If `zg index` or `zg query` fails, rerun the same command with `--debug`
+> for diagnostics (supported in both direct and server modes).
+> `zg status --mode direct --debug` reports per-file failures stored in an
+> existing index; rerun a failed direct command to diagnose command-level
+> fatal errors. Use
+> `zg status --mode server --debug` to inspect recorded server indexing errors.
+> For server connection failures, check `zg server status` and the
+> [server logs](./docs/06-server.md#logs-and-state).
+
+### 2. Choose how to search
+
+#### For agents: ask with OpenCode
+
+With [OpenCode](https://opencode.ai/) configured:
+
+```bash
+zg install --target opencode --yes
+opencode models
+opencode run --model opencode/nemotron-3-ultra-free \
+  "An unseen creature left a few marks. What did the detective infer? Cite local evidence."
+```
+
+Free model availability can change. Check `opencode models` and replace the
+example model with one that is currently available in your environment.
+
+OpenCode chooses zg on its own—the prompt does not name a tool.
+
+<details>
+<summary><strong>See the full agent run and answer</strong></summary>
+
+```text
+⚙ zvec_grep_zvec_grep_search {"root":".../zg-mystery","query":"An unseen creature left a few marks. What did the detective infer?","fts":["marks","unseen creature","inferred","detective"],"fuse":true}
+→ Read sherlock-holmes.txt [offset=5440, limit=120]
+
+Answer:
+The detective is Sherlock Holmes in *The Adventure of the Crooked Man*.
+From the animal's foot-marks, he inferred:
+
+- It was not a dog, cat, monkey, or other familiar creature: its print had
+  five foot-pads, long nails, and was nearly as large as a dessert-spoon
+  (sherlock-holmes.txt:5479-5486).
+- It had a long body and very short legs: nearly two feet long, but with a
+  stride of only about three inches (sherlock-holmes.txt:5497-5502).
+- It was carnivorous because it climbed the curtain toward a canary's cage
+  (sherlock-holmes.txt:5509-5510).
+- It was probably from the weasel or stoat tribe, though unusually large
+  (sherlock-holmes.txt:5514-5516).
+
+Holmes also inferred that a man entered through the window with it and later
+left with the key (sherlock-holmes.txt:5464-5470, 5527-5528).
+```
+
+</details>
+
+#### For humans: search directly
+
+Search the same bookshelf directly, without an agent:
+
+```bash
+zg query --human "An unseen creature left a few marks. What did the detective infer?" --limit 3
+```
+
+zg returns the relevant passages from `sherlock-holmes.txt`, ranked ahead of
+`alice-in-wonderland.txt`.
+
+### Index embedding concurrency and GPU errors
+
+`zg --index --index-embedding-concurrency <n>` and
+`ZVEC_GREP_INDEX_EMBEDDING_CONCURRENCY` control embedding concurrency while
+building or updating an index, for both local and remote models. The environment
+variable also applies to automatic indexing and refresh. These controls do not
+change query-vector inference. The CLI option is accepted only with `--index`.
+
+For llama.cpp, the limit controls contexts per indexing model instance. For
+Transformers.js, it controls calls in flight on one cached pipeline and does not
+guarantee simultaneous native/GPU execution. Both cap positive integer values
+at **8**. For Potion/model2vec, it controls concurrent embedding batches without
+that cap; the default is **2** and the CPU worker pool has its own capacity limit.
+For remote models, both controls set the maximum concurrent batches without the
+cap of 8. Existing adaptive scheduling and its defaults remain unchanged; it may
+reduce concurrency after rate limits or retryable failures.
+
+The priority is the explicit CLI/API index option, then the index environment
+variable, then `ZVEC_GREP_LLAMA_CONTEXT_PARALLELISM` (llama.cpp indexing only),
+then the automatic default.
+
+For llama.cpp and Transformers.js, CPU execution or a runtime without a VRAM
+query uses 1 unless overridden. Transformers.js currently has no VRAM query, so
+its automatic limit is 1. When a GPU runtime provides free VRAM, the limit is
+`floor(freeVRAM × 0.25 / 150 MiB)`, clamped to 1–8; a failed or invalid VRAM
+query uses 2. This retains the existing 150 MiB heuristic, which is not a
+guarantee that a model will fit in memory.
+
+For CUDA errors, memory exhaustion, or native crashes, try a limit of 1 and
+retry the index. These examples run directly so the new environment takes
+effect immediately:
+
+```bash
+export ZVEC_GREP_INDEX_EMBEDDING_CONCURRENCY=1
+zg --index --mode direct
+```
+
+Windows PowerShell:
+
+```powershell
+$env:ZVEC_GREP_INDEX_EMBEDDING_CONCURRENCY = "1"
+zg --index --mode direct
+```
+
+An explicit CLI option overrides the environment for that index operation,
+including when using the daemon; no daemon restart is needed for the CLI option:
+
+```bash
+export ZVEC_GREP_INDEX_EMBEDDING_CONCURRENCY=8
+zg --index --index-embedding-concurrency 1
+```
+
+To change the daemon's environment-variable default, update its startup
+environment, then run `zg --server off` and `zg --server on` from that environment.
+If an agent launches zg, update its environment and restart the agent/MCP
+connection too. JavaScript exceptions can be caught, but native aborts can
+terminate the process before any CPU fallback runs. A limit of 1 reduces
+concurrency; it does not prevent every GPU failure. You can also retry with
+`--device cpu`.
+
+<a id="benchmarks"></a>
+
+## 📊 Benchmarks
+
+Each benchmark uses paired A/B runs with tasks, agent/model, prompt,
+environment, and limits held constant; only zg access and usage guidance
+differ.
+
+See the [benchmark documentation](./benchmarks/README.md) for full results and
+reproduction details.
+
+### 1. Cross-Domain Agent Benchmark
+
+[SWE-QA-Bench](./benchmarks/swe-qa-bench/README.md) uses Claude Code with
+Claude Opus 5 at high reasoning effort;
+[BrowseComp-Plus](./benchmarks/browse-comp-plus/README.md) uses Codex
+gpt-5.6-sol at medium reasoning effort. Both zg profiles use Qwen3.7 Text
+Embedding.
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="./.github/assets/benchmark-overall-retrieval-indexed-v4-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="./.github/assets/benchmark-overall-retrieval-indexed-v4-light.svg">
+    <img src="./.github/assets/benchmark-overall-retrieval-indexed-v4-light.svg" alt="Overall zg benchmark results for Coding and general text retrieval, comparing answer quality, input tokens, tool calls, and agent time against Baseline" width="1200" />
+  </picture>
+</p>
+
+- **Why it helps:** semantic discovery narrows the search space, ranked lexical
+  retrieval anchors exact identifiers, and compact evidence reduces broad
+  scans, repeated tool calls, and model context.
+- **Why it generalizes:** the same retrieval loop works across domains—code is
+  indexed with symbols, signatures, and breadcrumbs, while prose is retrieved
+  as focused sections and chunks.
+
+### 2. Real-World Case Studies
+
+<table align="center">
+  <tr>
+    <td align="center">
+      <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="./.github/assets/benchmark-repository-top3-v2.png">
+        <source media="(prefers-color-scheme: light)" srcset="./.github/assets/benchmark-repository-top3-v2-light.png">
+        <img src="./.github/assets/benchmark-repository-top3-v2-light.png" alt="Baseline to zg comparison across three repository-comprehension tasks: Judge score, input tokens, tool calls, and wall time" width="980" />
+      </picture>
+    </td>
+  </tr>
+</table>
+
+- **[Pylint](https://github.com/pylint-dev/pylint) — Python static analysis:** the task asks how AST node handling
+  separates annotated and non-annotated attribute initialization. Symbol-aware
+  retrieval is useful because the architectural entry point is not known in
+  advance.
+- **[Matplotlib](https://github.com/matplotlib/matplotlib) — plotting and rendering:** the task traces `FontInfo` and font
+  selection through multiple math-text rendering stages. Ranked semantic and
+  lexical evidence helps reconstruct the cross-file data and control flow.
+- **[Django](https://github.com/django/django) — web framework:** the task connects username uniqueness, ORM
+  transactions, and formset bulk operations. Compact ranked evidence brings
+  the distributed design rationale together.
+
+<details>
+<summary><strong>Repository questions</strong></summary>
+
+| Repository | Question type | Question |
+| --- | --- | --- |
+| **`pylint-dev/pylint`** | What<br>Architecture exploration | What is the architectural pattern that distinguishes type-annotated from non-annotated instance attribute initialization using AST node type separation? |
+| **`matplotlib/matplotlib`** | Where<br>Data / Control-flow | Where does the `FontInfo` NamedTuple propagate font metrics and glyph data through the mathematical text rendering pipeline, and what control flow determines whether the `postscript_name` or the `FT2Font` object is used at different stages of character rendering? |
+| **`django/django`** | Why<br>Design rationale | Why does the User model's unique constraint on the username field interact with Django's ORM transaction handling, and what cascading effects would occur if this constraint were removed on an existing database with formset-based bulk operations? |
+
+</details>
+
+> zg works best when evidence spans files or modules and the target location is
+> unknown, especially for call-chain, data-flow, and architectural questions.
+> Since agents decide when and how to use it, results vary by model and run;
+> repeated-run averages are more reliable.
+
+## 📚 Documentation
+
+| Guide | What you can do |
+| :--- | :--- |
+| [Agent integrations](./docs/01-agents.md) | Connect zg to Codex, Claude Code, Qwen Code, Qoder, Cursor, or OpenCode and verify that it works. |
+| [CLI guide](./docs/02-cli.md) | Search, index, and manage your local workspaces from the terminal. |
+| [MCP guide](./docs/03-mcp.md) | Understand which zg tools your agent can use and how access is secured. |
+| [Retrieval pipeline](./docs/04-pipeline.md) | Choose what to index, keep it fresh, and get better search results. |
+| [Architecture](./docs/05-architecture.md) | See how zg handles your query and where your data stays. |
+| [Server and execution modes](./docs/06-server.md) | Choose between one-off commands and a long-running local server. |
+| [Embedding models](./docs/07-embedding.md) | Pick the right model for speed, search quality, privacy, and your hardware. |
+| [Roadmap](./docs/08-roadmap.md) | See what is coming next and help shape zg's priorities. |
+
+<a id="community"></a>
+
+## 🤝 Join Our Community
+
+<div align="center">
+
+| 💬 DingTalk | 📱 WeChat | 🎮 Discord | X (Twitter) |
+| :---: | :---: | :---: | :---: |
+| <img src="https://zvec.oss-cn-hongkong.aliyuncs.com/qrcode/dingding.png" width="150" alt="DingTalk QR Code"/> | <img src="https://zvec.oss-cn-hongkong.aliyuncs.com/qrcode/wechat.png?v5" width="150" alt="WeChat QR Code"/> | [![Discord](https://img.shields.io/badge/Discord-Join%20Server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/rKddFBBu9z) | [![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/ZvecAI)](<https://x.com/ZvecAI>) |
+| Scan to join | Scan to join | Click to join | Click to follow |
+
+</div>
+
+## ❤️ Contributing
+
+Community contributions are always welcome—bug fixes, features, and
+documentation improvements all help make zvec-grep better.
+
+Check out our [Contributing Guide](./CONTRIBUTING.md) to get started!