@ushiradineth/veil 0.2.3 → 0.4.0
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.
- package/README.md +159 -34
- package/dist/bin.js +33058 -15470
- package/package.json +16 -2
package/README.md
CHANGED
|
@@ -1,8 +1,19 @@
|
|
|
1
|
-
# Veil
|
|
1
|
+
# Veil Agent Toolkit
|
|
2
2
|
|
|
3
|
-
Veil
|
|
3
|
+
Veil helps coding agents find the right code fast.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Without Veil, agents often:
|
|
6
|
+
|
|
7
|
+
- search too many files
|
|
8
|
+
- guess where symbols are
|
|
9
|
+
- repeat the same scans after each change
|
|
10
|
+
|
|
11
|
+
With Veil, agents can:
|
|
12
|
+
|
|
13
|
+
- use `discover` to get files, symbols, and code chunks in one step
|
|
14
|
+
- use `lookup` to get the most relevant context for the task
|
|
15
|
+
- use `files`, `symbols`, and `search` for focused follow-up
|
|
16
|
+
- use built-in git and web tools instead of ad hoc shell commands
|
|
6
17
|
|
|
7
18
|
Agents should:
|
|
8
19
|
|
|
@@ -10,48 +21,162 @@ Agents should:
|
|
|
10
21
|
- Narrow with `lookup`, `search`, `files`, or `symbols`
|
|
11
22
|
- Use built-in git and web commands instead of ad hoc shell fallbacks
|
|
12
23
|
|
|
13
|
-
##
|
|
24
|
+
## What It Is For
|
|
25
|
+
|
|
26
|
+
Veil is built for agents that need to move from prompt to implementation quickly.
|
|
27
|
+
|
|
28
|
+
It gives the agent indexed access to files, symbols, and relevant code chunks, so it can retrieve precise context before writing code. This reduces broad file reads and repeated text scans, improves token efficiency, and shortens time to first meaningful code change.
|
|
29
|
+
|
|
30
|
+
In practice, Veil acts as a local retrieval layer for coding agents: discover where code lives, resolve symbols, pull focused context, then execute edits.
|
|
31
|
+
|
|
32
|
+
## Setup
|
|
14
33
|
|
|
15
|
-
|
|
34
|
+
### Initialize using the CLI (recommended)
|
|
16
35
|
|
|
17
|
-
|
|
36
|
+
```bash
|
|
37
|
+
npx -y @ushiradineth/veil@latest init
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Setup manually
|
|
41
|
+
|
|
42
|
+
#### Install the CLI
|
|
43
|
+
|
|
44
|
+
Package managers:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npm i -g @ushiradineth/veil
|
|
48
|
+
pnpm add -g @ushiradineth/veil
|
|
49
|
+
yarn global add @ushiradineth/veil
|
|
50
|
+
bun add -g @ushiradineth/veil
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Homebrew:
|
|
18
54
|
|
|
19
55
|
```bash
|
|
20
56
|
brew tap ushiradineth/homebrew https://github.com/ushiradineth/homebrew
|
|
21
57
|
brew install veil
|
|
22
58
|
```
|
|
23
59
|
|
|
24
|
-
|
|
60
|
+
#### Install the Skill (based on your preference)
|
|
61
|
+
|
|
62
|
+
CLI skill:
|
|
25
63
|
|
|
26
64
|
```bash
|
|
27
|
-
|
|
65
|
+
npx -y skills add https://github.com/ushiradineth/veil --skill veil-cli
|
|
28
66
|
```
|
|
29
67
|
|
|
30
|
-
|
|
68
|
+
MCP skill:
|
|
31
69
|
|
|
32
70
|
```bash
|
|
33
|
-
npx -y skills add https://github.com/ushiradineth/veil --skill veil
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
71
|
+
npx -y skills add https://github.com/ushiradineth/veil --skill veil-mcp
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### MCP Client Configuration
|
|
75
|
+
|
|
76
|
+
<details>
|
|
77
|
+
<summary>Codex</summary>
|
|
78
|
+
Follow the <a href="https://developers.openai.com/codex/mcp/#configure-with-the-cli">configure MCP guide</a>
|
|
79
|
+
using the standard config from above. You can also install Veil using the Codex CLI:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
codex mcp add veil -- npx -y @ushiradineth/veil@latest mcp server
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
</details>
|
|
86
|
+
|
|
87
|
+
<details>
|
|
88
|
+
<summary>Claude Code</summary>
|
|
89
|
+
|
|
90
|
+
Install via CLI:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
claude mcp add --scope user veil -- npx -y @ushiradineth/veil@latest mcp server
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
See the <a href="https://code.claude.com/docs/en/mcp">Claude Code MCP guide</a> for more details.
|
|
97
|
+
|
|
98
|
+
</details>
|
|
99
|
+
|
|
100
|
+
<details>
|
|
101
|
+
<summary>OpenCode</summary>
|
|
102
|
+
|
|
103
|
+
Add the following configuration to your `opencode.json` file. If you do not have one, create it at `~/.config/opencode/opencode.json` (<a href="https://opencode.ai/docs/mcp-servers">guide</a>):
|
|
104
|
+
|
|
105
|
+
```json
|
|
106
|
+
{
|
|
107
|
+
"$schema": "https://opencode.ai/config.json",
|
|
108
|
+
"mcp": {
|
|
109
|
+
"veil": {
|
|
110
|
+
"type": "local",
|
|
111
|
+
"command": ["npx", "-y", "@ushiradineth/veil@latest", "mcp", "server"]
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
</details>
|
|
118
|
+
|
|
119
|
+
<details>
|
|
120
|
+
<summary>Cursor</summary>
|
|
121
|
+
|
|
122
|
+
Click to install:
|
|
123
|
+
|
|
124
|
+
[<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/en/install-mcp?name=veil&config=eyJjb21tYW5kIjoibnB4IC15IEB1c2hpcmFkaW5ldGgvdmVpbEBsYXRlc3QgbWNwIHNlcnZlciJ9)
|
|
125
|
+
|
|
126
|
+
Or install manually in `Cursor Settings` -> `MCP` -> `New MCP Server` with:
|
|
127
|
+
|
|
128
|
+
```json
|
|
129
|
+
{
|
|
130
|
+
"mcpServers": {
|
|
131
|
+
"veil": {
|
|
132
|
+
"command": "npx",
|
|
133
|
+
"args": ["-y", "@ushiradineth/veil@latest", "mcp", "server"]
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
</details>
|
|
140
|
+
|
|
141
|
+
<details>
|
|
142
|
+
<summary>Windsurf</summary>
|
|
143
|
+
Follow the <a href="https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json">configure MCP guide</a>
|
|
144
|
+
using the standard config from above.
|
|
145
|
+
</details>
|
|
146
|
+
|
|
147
|
+
## Capabilities
|
|
148
|
+
|
|
149
|
+
If index build fails with `Missing required parser runtimes for enabled built-ins`, reinstall dependencies (`bun install` or `npm install`) and rerun `veil init` parser setup. In read-only environments, ensure `tree-sitter` runtime artifacts are available before running `build` or `refresh`.
|
|
150
|
+
|
|
151
|
+
Use the same retrieval and context capability surface from either CLI or MCP.
|
|
152
|
+
|
|
153
|
+
MCP breaking change: canonical tool names are now prefixed with `veil_` and compatibility aliases were removed.
|
|
154
|
+
|
|
155
|
+
MCP responses are TOON text only and optimized for compact machine parsing. Guidance is included only when confidence is not high/full. Retrieval tools (`discover`, `lookup`, `search`) return compact chunk content by default, and full chunk content is opt-in (`--include-content` / `include_content`).
|
|
156
|
+
|
|
157
|
+
Retrieval query tools run freshness checks by default and now refresh on dirty workspace changes so indexed results stay aligned with current local edits.
|
|
158
|
+
|
|
159
|
+
| Capability | What it does | CLI command | MCP tool |
|
|
160
|
+
| ------------------------------------ | --------------------------------------------------------------------- | -------------------------------------------------------- | ---------------------- |
|
|
161
|
+
| Index status | Shows index freshness, manifest health, and stale reasons. | `veil status --workspace .` | `veil_status` |
|
|
162
|
+
| Incremental index refresh | Rebuilds index records from changed files only. | `veil refresh --workspace . --mode changed` | `veil_refresh` |
|
|
163
|
+
| Full index rebuild | Rebuilds all indexed records from scratch. | `veil build --workspace .` | `veil_build` |
|
|
164
|
+
| Setup plan | Returns non-interactive setup plan for CLI or MCP mode. | `veil init --mode cli --interactive false --raw-output` | `veil_init` |
|
|
165
|
+
| Discover files, symbols, chunks | Returns a mixed set of high-signal retrieval context in one call. | `veil discover --workspace . --query "<query>"` | `veil_discover` |
|
|
166
|
+
| Targeted chunk fetch | Fetches full content for one chunk id after compact retrieval. | `veil chunk --workspace . --id <chunk-id>` | `veil_chunk` |
|
|
167
|
+
| Intent-aware ranked lookup | Ranks relevant context with intent-aware scoring for coding tasks. | `veil lookup --workspace . --query "<query>"` | `veil_lookup` |
|
|
168
|
+
| File path retrieval | Finds matching file paths for quick navigation. | `veil files --workspace . --query "<query>"` | `veil_files` |
|
|
169
|
+
| Symbol retrieval | Finds functions, classes, types, and methods by name. | `veil symbols --workspace . --query "<query>"` | `veil_symbols` |
|
|
170
|
+
| Content search | Searches indexed code and docs chunks by query. | `veil search --workspace . --query "<query>"` | `veil_search` |
|
|
171
|
+
| Grammar list | Shows parser enabled and installed status. | `veil grammar list --workspace .` | `veil_grammar_list` |
|
|
172
|
+
| Grammar install | Enables parser IDs. | `veil grammar install --parsers js,ts` | `veil_grammar_install` |
|
|
173
|
+
| Grammar remove | Disables parser IDs. | `veil grammar remove --parsers ts` | `veil_grammar_remove` |
|
|
174
|
+
| Grammar update | Refreshes parser metadata for selected or all installed IDs. | `veil grammar update --all` | `veil_grammar_update` |
|
|
175
|
+
| Web search | Runs multi-provider web search for external context. | `veil web-search --query "<query>"` | `veil_web_search` |
|
|
176
|
+
| URL fetch and markdown normalization | Fetches web content and normalizes output for agent-friendly reading. | `veil fetch-url --url <url> --format markdown` | `veil_fetch_url` |
|
|
177
|
+
| Git status | Shows branch state, dirty files, and untracked changes. | `veil git-status --workspace .` | `veil_git_status` |
|
|
178
|
+
| Git log | Returns recent commits with metadata for project history checks. | `veil git-log --workspace . --limit 10` | `veil_git_log` |
|
|
179
|
+
| Git diff | Returns working tree or revision-range diffs. | `veil git-diff --workspace .` | `veil_git_diff` |
|
|
180
|
+
| Git show | Shows full details for a specific revision. | `veil git-show --workspace . --rev HEAD` | `veil_git_show` |
|
|
181
|
+
| GitHub context lookup | Pulls repository or pull request context via `gh` integration. | `veil gh-lookup --repo <owner/repo> --kind repo_context` | `veil_gh_lookup` |
|
|
182
|
+
| Runtime diagnostics | Surfaces cache counters and latency diagnostics, with optional reset. | `veil diagnostics [--reset]` | `veil_diagnostics` |
|