@ushiradineth/veil 0.2.1 → 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 +33 -93
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,117 +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
- ```bash
21
- npm i -g @ushiradineth/veil
22
- ```
23
-
24
- Or run without install:
25
-
26
- ```bash
27
- npx -y @ushiradineth/veil@latest status --workspace .
28
- ```
29
-
30
- ## Install Skill
31
-
32
- ```bash
33
- npx -y skills add https://github.com/ushiradineth/veil/tree/main --skill veil
34
- ```
35
-
36
- ## CLI Examples
17
+ ### With Homebrew
37
18
 
38
19
  ```bash
39
- # status and refresh
40
- veil status --workspace .
41
- veil init --workspace .
42
- veil refresh --workspace . --mode changed
43
-
44
- # local index retrieval
45
- veil discover --workspace . --query "find build logic"
46
- veil lookup --workspace . --query "where is parseNdjson defined"
47
- veil search --workspace . --query "pnpm install"
48
-
49
- # web and fetch
50
- veil web-search --query "typescript language server" --limit 5
51
- veil fetch-url --url https://www.iana.org/domains/reserved --format markdown
52
-
53
- # git and github context
54
- veil git-status --workspace .
55
- veil git-log --workspace . --limit 10
56
- veil git-diff --workspace .
57
- veil git-show --workspace . --rev HEAD
58
- veil gh-lookup --repo ushiradineth/veil --kind repo_context
59
-
60
- # diagnostics
61
- veil diagnostics
62
-
63
- # optional MCP server
64
- veil mcp server
65
-
20
+ brew tap ushiradineth/homebrew https://github.com/ushiradineth/homebrew
21
+ brew install veil
66
22
  ```
67
23
 
68
- ## Commands
69
-
70
- - `status`, `init`, `refresh`
71
- - `discover`, `lookup`, `files`, `symbols`, `search`
72
- - `web-search`, `fetch-url`
73
- - `git-status`, `git-log`, `git-diff`, `git-show`, `gh-lookup`
74
- - `diagnostics`
75
-
76
- ## Development Commands
24
+ ### npm
77
25
 
78
26
  ```bash
79
- nix run nixpkgs#bun -- install
80
- nix run nixpkgs#bun -- run lint
81
- nix run nixpkgs#bun -- test ./src/test.ts
27
+ npm i -g @ushiradineth/veil
82
28
  ```
83
29
 
84
- ## Benchmark A/B
85
-
86
- Run A/B strategy benchmarks (Veil MCP vs Veil CLI+skill) with competitor cells:
30
+ ## Install Skill
87
31
 
88
32
  ```bash
89
- 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
33
+ npx -y skills add https://github.com/ushiradineth/veil --skill veil
90
34
  ```
91
35
 
92
- ## Release
93
-
94
- Releases follow a trunk-gated PR promotion flow.
95
-
96
- 1. Dispatch the `Release` workflow from `main` with a bump type (`patch`, `minor`, `major`).
97
- This creates a `release/vX.Y.Z` branch and opens a PR to `main`.
98
- 2. CI runs on the PR. Merge when checks pass.
99
- 3. Merging triggers the `Publish` workflow which tags, publishes to npm, creates a GitHub release,
100
- and updates the Homebrew formula in the tap repository.
101
-
102
- Required GitHub secrets:
103
-
104
- | Secret | Purpose |
105
- | --------------------------- | ---------------------------------------------- |
106
- | `NPM_TOKEN` | Publish to npm registry |
107
- | `RELEASE_PR_TOKEN` | PAT to open release PR so CI triggers on it |
108
- | `HOMEBREW_TAP_GITHUB_TOKEN` | PAT with write access to the Homebrew tap repo |
109
-
110
- Optional repository variables:
111
-
112
- | Variable | Default | Purpose |
113
- | ----------------------- | --------------------------- | ------------------------ |
114
- | `HOMEBREW_TAP_REPO` | `ushiradineth/homebrew-tap` | Tap owner/repo |
115
- | `HOMEBREW_FORMULA_PATH` | `Formula/veil.rb` | Formula file path in tap |
116
-
117
- Branch protection on `main` should require the `CI / test` check context before merge.
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.1",
3
+ "version": "0.2.3",
4
4
  "private": false,
5
5
  "license": "MIT",
6
6
  "type": "module",