@0x1labs/vyer 0.1.0 → 0.1.2

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 +70 -15
  2. package/package.json +40 -10
package/README.md CHANGED
@@ -1,26 +1,81 @@
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
5
4
 
6
- ```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
9
- ```
5
+ **The warm code-context engine for AI coding agents.**
6
+
7
+ [![npm](https://img.shields.io/npm/v/@0x1labs/vyer?color=cb3837&logo=npm&logoColor=white)](https://www.npmjs.com/package/@0x1labs/vyer)
8
+ [![license](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue.svg)](https://github.com/chirayuoli/vyer)
9
+ [![GitHub](https://img.shields.io/badge/source-chirayuoli%2Fvyer-181717?logo=github)](https://github.com/chirayuoli/vyer)
10
+
11
+ </div>
12
+
13
+ ---
14
+
15
+ One MCP tool that gives your coding agent fast, structure-aware sight into a codebase — and a safe,
16
+ precise way to change it. Warm, resident, always fresh. **Fully local.** This package downloads the
17
+ matching prebuilt `vyer` binary for your platform on install.
10
18
 
11
- Wire it into your agent host (Claude Code / Cursor / Windsurf):
19
+ ## Use it
20
+
21
+ Vyer is an **MCP server** — your agent host launches it and talks to it over stdio. You don't run
22
+ `vyer serve` by hand; you point your host (Claude Code / Cursor / Windsurf / Cline) at it:
12
23
 
13
24
  ```jsonc
14
- { "mcpServers": { "vyer": { "command": "npx", "args": ["-y", "@0x1labs/vyer", "serve", "--root", "."] } } }
25
+ // .mcp.json (or your host's MCP config)
26
+ {
27
+ "mcpServers": {
28
+ "vyer": { "command": "npx", "args": ["-y", "@0x1labs/vyer", "serve", "--root", ".", "--watch", "--allow-writes"] }
29
+ }
30
+ }
31
+ ```
32
+
33
+ Claude Code one-liner:
34
+
35
+ ```sh
36
+ claude mcp add vyer -- npx -y @0x1labs/vyer serve --root . --watch --allow-writes
15
37
  ```
16
38
 
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:
39
+ `--allow-writes` lets Vyer edit (drop it for read-only). Then tell your agent to prefer it:
20
40
 
21
41
  ```sh
22
- cargo install --git https://github.com/chirayuoli/vyer vyer-server
42
+ npx -y @0x1labs/vyer init # drops a managed note into ./CLAUDE.md (idempotent)
43
+ ```
44
+
45
+ Want a global `vyer` command? `npm install -g @0x1labs/vyer`. To check it from a terminal (no agent),
46
+ use `vyer version` or `vyer query "<search>"` — `serve` only does something when an agent drives it.
47
+
48
+ ## What you get
49
+
50
+ | | |
51
+ |---|---|
52
+ | **Fast** | a resident warm core — roughly 4 ms a query, never a cold rescan |
53
+ | **Precise** | hybrid lexical + structural + graph search; real AST spans, not text blobs |
54
+ | **Safe** | deterministic AST edits — atomic, re-parse-checked, never stale after a write |
55
+ | **Tiny** | one MCP tool (plus a gated editor) — about 2k tokens of metadata per turn |
56
+ | **Polyglot** | 14 languages via tree-sitter (Rust, Python, JS/TS/TSX, Go, C/C++, and more) |
57
+ | **Local** | your code never leaves the machine; sandboxed writes; no shelling out |
58
+
59
+ ## One loop, not just search
60
+
61
+ ```jsonc
62
+ // find — describe it or name it
63
+ { "queries": [{ "q": "where do we validate the auth token" }] }
64
+
65
+ // understand — definition + callers + callees + tests, in one call
66
+ { "queries": [{ "q": "validateToken", "detail": "context" }] }
67
+
68
+ // change — a surgical, atomic edit (this is code_apply)
69
+ { "edits": [{ "locator": "src/auth/token.rs#validate_token", "rename": "verify_token" }] }
23
70
  ```
24
71
 
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.
72
+ ## Full documentation
73
+
74
+ Quickstart, the agent playbook, security model, and benchmarks all live in the repo:
75
+
76
+ ### → **https://github.com/chirayuoli/vyer**
77
+
78
+ No prebuilt binary for your platform? Build from source (needs Rust 1.85+):
79
+ `cargo install --git https://github.com/chirayuoli/vyer vyer-server`
80
+
81
+ <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,16 +1,46 @@
1
1
  {
2
2
  "name": "@0x1labs/vyer",
3
- "version": "0.1.0",
4
- "publishConfig": { "access": "public" },
3
+ "version": "0.1.2",
4
+ "publishConfig": {
5
+ "access": "public"
6
+ },
5
7
  "description": "Vyer — the warm code-context engine for AI coding agents (MCP server).",
6
- "keywords": ["mcp", "ai", "agent", "code-search", "code-context", "llm", "claude", "cursor"],
8
+ "keywords": [
9
+ "mcp",
10
+ "ai",
11
+ "agent",
12
+ "code-search",
13
+ "code-context",
14
+ "llm",
15
+ "claude",
16
+ "cursor"
17
+ ],
7
18
  "homepage": "https://github.com/chirayuoli/vyer",
8
- "repository": { "type": "git", "url": "github:chirayuoli/vyer" },
19
+ "repository": {
20
+ "type": "git",
21
+ "url": "github:chirayuoli/vyer"
22
+ },
9
23
  "license": "(MIT OR Apache-2.0)",
10
- "bin": { "vyer": "bin/vyer.js" },
11
- "scripts": { "postinstall": "node install.js" },
12
- "files": ["bin/vyer.js", "install.js"],
13
- "engines": { "node": ">=16" },
14
- "os": ["darwin", "linux", "win32"],
15
- "cpu": ["x64", "arm64"]
24
+ "bin": {
25
+ "vyer": "bin/vyer.js"
26
+ },
27
+ "scripts": {
28
+ "postinstall": "node install.js"
29
+ },
30
+ "files": [
31
+ "bin/vyer.js",
32
+ "install.js"
33
+ ],
34
+ "engines": {
35
+ "node": ">=16"
36
+ },
37
+ "os": [
38
+ "darwin",
39
+ "linux",
40
+ "win32"
41
+ ],
42
+ "cpu": [
43
+ "x64",
44
+ "arm64"
45
+ ]
16
46
  }