@ushiradineth/veil 0.2.2 → 0.2.3

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 +30 -107
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,134 +1,57 @@
1
1
  # Veil CLI
2
2
 
3
- Veil is a fast CLI and skill for local code retrieval and agent context workflows.
3
+ Veil is a CLI/MCP Toolkit built for agent workflows that need fast, token-lean context before editing code.
4
4
 
5
- It indexes a repository and provides focused commands for files, symbols, semantic lookup,
6
- web/fetch context, and git or GitHub reads.
5
+ It indexes a repository and provides focused commands for files, symbols, semantic lookup, web/fetch context, and git or GitHub reads.
7
6
 
8
- ## What It Is For
9
-
10
- Veil is built for agent workflows that need fast, token-lean context before editing code.
7
+ Agents should:
11
8
 
12
9
  - Start broad with `discover`
13
10
  - Narrow with `lookup`, `search`, `files`, or `symbols`
14
11
  - Use built-in git and web commands instead of ad hoc shell fallbacks
15
12
 
16
- ## Install
13
+ ## Install the CLI
17
14
 
18
15
  Requires Node.js 20 or later.
19
16
 
20
- ### Homebrew
17
+ ### With Homebrew
21
18
 
22
19
  ```bash
23
20
  brew tap ushiradineth/homebrew https://github.com/ushiradineth/homebrew
24
21
  brew install veil
25
22
  ```
26
23
 
27
- ### Nix
28
-
29
- Run without installing:
30
-
31
- ```bash
32
- nix run github:ushiradineth/veil
33
- ```
34
-
35
24
  ### npm
36
25
 
37
26
  ```bash
38
27
  npm i -g @ushiradineth/veil
39
28
  ```
40
29
 
41
- Or run without install:
42
-
43
- ```bash
44
- npx -y @ushiradineth/veil@latest status --workspace .
45
- ```
46
-
47
30
  ## Install Skill
48
31
 
49
32
  ```bash
50
- npx -y skills add https://github.com/ushiradineth/veil/tree/main --skill veil
51
- ```
52
-
53
- ## CLI Examples
54
-
55
- ```bash
56
- # status and refresh
57
- veil status --workspace .
58
- veil init --workspace .
59
- veil refresh --workspace . --mode changed
60
-
61
- # local index retrieval
62
- veil discover --workspace . --query "find build logic"
63
- veil lookup --workspace . --query "where is parseNdjson defined"
64
- veil search --workspace . --query "pnpm install"
65
-
66
- # web and fetch
67
- veil web-search --query "typescript language server" --limit 5
68
- veil fetch-url --url https://www.iana.org/domains/reserved --format markdown
69
-
70
- # git and github context
71
- veil git-status --workspace .
72
- veil git-log --workspace . --limit 10
73
- veil git-diff --workspace .
74
- veil git-show --workspace . --rev HEAD
75
- veil gh-lookup --repo ushiradineth/veil --kind repo_context
76
-
77
- # diagnostics
78
- veil diagnostics
79
-
80
- # optional MCP server
81
- veil mcp server
82
-
83
- ```
84
-
85
- ## Commands
86
-
87
- - `status`, `init`, `refresh`
88
- - `discover`, `lookup`, `files`, `symbols`, `search`
89
- - `web-search`, `fetch-url`
90
- - `git-status`, `git-log`, `git-diff`, `git-show`, `gh-lookup`
91
- - `diagnostics`
92
-
93
- ## Development Commands
94
-
95
- ```bash
96
- nix run nixpkgs#bun -- install
97
- nix run nixpkgs#bun -- run lint
98
- nix run nixpkgs#bun -- test ./src/test.ts
99
- ```
100
-
101
- ## Benchmark A/B
102
-
103
- Run A/B strategy benchmarks (Veil MCP vs Veil CLI+skill) with competitor cells:
104
-
105
- ```bash
106
- nix run nixpkgs#bun -- run src/bench-suite.ts --workspace /path/to/repo --agents veil,firecrawl --strategies mcp_transport,cli_skill --profile smoke --cold 1 --warm 1
107
- ```
108
-
109
- ## Release
110
-
111
- Releases follow a trunk-gated PR promotion flow.
112
-
113
- 1. Dispatch the `Release` workflow from `main` with a bump type (`patch`, `minor`, `major`).
114
- This creates a `release/vX.Y.Z` branch and opens a PR to `main`.
115
- 2. CI runs on the PR. Merge when checks pass.
116
- 3. Merging triggers the `Publish` workflow which tags, publishes to npm, creates a GitHub release,
117
- and updates the Homebrew formula in the tap repository.
118
-
119
- Required GitHub secrets:
120
-
121
- | Secret | Purpose |
122
- | --------------------------- | ---------------------------------------------- |
123
- | `NPM_TOKEN` | Publish to npm registry |
124
- | `RELEASE_PR_TOKEN` | PAT to open release PR so CI triggers on it |
125
- | `HOMEBREW_TAP_GITHUB_TOKEN` | PAT with write access to the Homebrew tap repo |
126
-
127
- Optional repository variables:
128
-
129
- | Variable | Default | Purpose |
130
- | ----------------------- | ----------------------- | ------------------------ |
131
- | `HOMEBREW_TAP_REPO` | `ushiradineth/homebrew` | Tap owner/repo |
132
- | `HOMEBREW_FORMULA_PATH` | `Formula/veil.rb` | Formula file path in tap |
133
-
134
- Branch protection on `main` should require the `CI / test` check context before merge.
33
+ npx -y skills add https://github.com/ushiradineth/veil --skill veil
34
+ ```
35
+
36
+ ## Commands and Examples
37
+
38
+ | Command | Description | Example |
39
+ | ------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------ |
40
+ | `status` | Show index freshness, manifest state, and stale reasons. | `veil status --workspace .` |
41
+ | `init` | Initialize index if missing or stale. | `veil init --workspace .` |
42
+ | `build` | Force full index rebuild for workspace. | `veil build --workspace .` |
43
+ | `refresh` | Incremental index refresh using changed files. | `veil refresh --workspace . --mode changed` |
44
+ | `discover` | Combined retrieval across files, symbols, and chunks. | `veil discover --workspace . --query "find build logic"` |
45
+ | `lookup` | Intent-aware ranked retrieval with short reasoning. | `veil lookup --workspace . --query "where is parseNdjson defined"` |
46
+ | `files` | Search file paths by query. | `veil files --workspace . --query "workflow"` |
47
+ | `symbols` | Search symbols (functions, classes, types, methods). | `veil symbols --workspace . --query "TopKHeap"` |
48
+ | `search` | Search indexed content chunks in code or docs. | `veil search --workspace . --query "pnpm install"` |
49
+ | `web-search` | Multi-provider web search with ranked results. | `veil web-search --query "typescript language server" --limit 5` |
50
+ | `fetch-url` | Fetch URL content and normalize to markdown or text. | `veil fetch-url --url https://www.iana.org/domains/reserved --format markdown` |
51
+ | `git-status` | Show branch, dirty tree, and untracked summary. | `veil git-status --workspace .` |
52
+ | `git-log` | Show recent commits with metadata. | `veil git-log --workspace . --limit 10` |
53
+ | `git-diff` | Show working or ranged git diff. | `veil git-diff --workspace .` |
54
+ | `git-show` | Show one git revision with metadata and patch text. | `veil git-show --workspace . --rev HEAD` |
55
+ | `gh-lookup` | Pull GitHub repo or PR context via `gh` CLI. | `veil gh-lookup --repo ushiradineth/veil --kind repo_context` |
56
+ | `diagnostics` | Show cache counters and latency diagnostics. | `veil diagnostics` |
57
+ | `mcp server` | Start MCP stdio server runtime. | `veil mcp server` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ushiradineth/veil",
3
- "version": "0.2.2",
3
+ "version": "0.2.3",
4
4
  "private": false,
5
5
  "license": "MIT",
6
6
  "type": "module",