@0x1labs/vyer 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +64 -13
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,26 +1,77 @@
1
- # @0x1labs/vyer (npm)
1
+ <div align="center">
2
2
 
3
- Thin installer for **[Vyer](https://github.com/chirayuoli/vyer)** — the warm code-context
4
- engine for AI coding agents (an MCP server).
3
+ # Vyer
4
+
5
+ **The warm code-context engine for AI coding agents.**
6
+
7
+ *rhymes with "buyer" · Swedish for "views, vistas, visions"*
8
+
9
+ [![npm](https://img.shields.io/npm/v/@0x1labs/vyer?color=cb3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/@0x1labs/vyer)
10
+ [![license](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](https://github.com/chirayuoli/vyer)
11
+ [![GitHub](https://img.shields.io/badge/source-chirayuoli%2Fvyer-181717?logo=github)](https://github.com/chirayuoli/vyer)
12
+
13
+ </div>
14
+
15
+ ---
16
+
17
+ One MCP tool that gives your coding agent fast, structure-aware sight into a codebase — and a safe,
18
+ precise way to change it. Warm, resident, always fresh. **Fully local.** This package downloads the
19
+ matching prebuilt `vyer` binary for your platform on install.
20
+
21
+ ## Use it
5
22
 
6
23
  ```sh
7
- npx @0x1labs/vyer serve --root . # run it (downloads the right prebuilt binary on first use)
8
- npm install -g @0x1labs/vyer # or install globally
24
+ npx -y @0x1labs/vyer serve --root . # run it, no install
25
+ npm install -g @0x1labs/vyer # or install the `vyer` command globally
9
26
  ```
10
27
 
11
- Wire it into your agent host (Claude Code / Cursor / Windsurf):
28
+ Wire it into your agent host (Claude Code / Cursor / Windsurf / Cline):
12
29
 
13
30
  ```jsonc
14
- { "mcpServers": { "vyer": { "command": "npx", "args": ["-y", "@0x1labs/vyer", "serve", "--root", "."] } } }
31
+ {
32
+ "mcpServers": {
33
+ "vyer": { "command": "npx", "args": ["-y", "@0x1labs/vyer", "serve", "--root", ".", "--watch"] }
34
+ }
35
+ }
15
36
  ```
16
37
 
17
- On install, `install.js` downloads the `vyer` binary matching your platform and this
18
- package's version from the project's GitHub Releases. If no prebuilt binary fits your
19
- platform, install from source instead:
38
+ Add `--allow-writes` to let it edit. Then point your agent at it with one command:
20
39
 
21
40
  ```sh
22
- cargo install --git https://github.com/chirayuoli/vyer vyer-server
41
+ vyer init # drops a managed note into ./CLAUDE.md so the agent prefers Vyer (idempotent)
23
42
  ```
24
43
 
25
- This package's version tracks the Vyer release it installs (npm `x.y.z` → git tag `vx.y.z`).
26
- License: MIT OR Apache-2.0.
44
+ ## What you get
45
+
46
+ | | |
47
+ |---|---|
48
+ | **Fast** | a resident warm core — roughly 4 ms a query, never a cold rescan |
49
+ | **Precise** | hybrid lexical + structural + graph search; real AST spans, not text blobs |
50
+ | **Safe** | deterministic AST edits — atomic, re-parse-checked, never stale after a write |
51
+ | **Tiny** | one MCP tool (plus a gated editor) — about 2k tokens of metadata per turn |
52
+ | **Polyglot** | 14 languages via tree-sitter (Rust, Python, JS/TS/TSX, Go, C/C++, and more) |
53
+ | **Local** | your code never leaves the machine; sandboxed writes; no shelling out |
54
+
55
+ ## One loop, not just search
56
+
57
+ ```jsonc
58
+ // find — describe it or name it
59
+ { "queries": [{ "q": "where do we validate the auth token" }] }
60
+
61
+ // understand — definition + callers + callees + tests, in one call
62
+ { "queries": [{ "q": "validateToken", "detail": "context" }] }
63
+
64
+ // change — a surgical, atomic edit (this is code_apply)
65
+ { "edits": [{ "locator": "src/auth/token.rs#validate_token", "rename": "verify_token" }] }
66
+ ```
67
+
68
+ ## Full documentation
69
+
70
+ Quickstart, the agent playbook, security model, and benchmarks all live in the repo:
71
+
72
+ ### → **https://github.com/chirayuoli/vyer**
73
+
74
+ No prebuilt binary for your platform? Build from source:
75
+ `cargo install --git https://github.com/chirayuoli/vyer vyer-server`
76
+
77
+ <div align="center"><sub>MIT OR Apache-2.0 · built by <a href="https://www.npmjs.com/org/0x1labs">0x1labs</a></sub></div>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@0x1labs/vyer",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "publishConfig": { "access": "public" },
5
5
  "description": "Vyer — the warm code-context engine for AI coding agents (MCP server).",
6
6
  "keywords": ["mcp", "ai", "agent", "code-search", "code-context", "llm", "claude", "cursor"],