@gkoreli/ghx 2.4.1 → 2.4.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.
- package/README.md +35 -9
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -146,21 +146,22 @@ go install github.com/gkoreli/ghx/v2/cmd/ghx@latest
|
|
|
146
146
|
The sidecar drives an ACP-capable agent under the hood, and it reads GitHub
|
|
147
147
|
through the authenticated [gh CLI](https://cli.github.com/) (`gh auth login`).
|
|
148
148
|
|
|
149
|
-
### 2. Configure the agent
|
|
149
|
+
### 2. Configure the agent (optional — zero-config works)
|
|
150
150
|
|
|
151
151
|
The sidecar speaks [Agent Client Protocol (ACP)](https://agentclientprotocol.com)
|
|
152
|
-
to its underlying model.
|
|
152
|
+
to its underlying model. **With no config at all, the pinned
|
|
153
153
|
[claude-agent-acp](https://www.npmjs.com/package/@agentclientprotocol/claude-agent-acp)
|
|
154
|
-
adapter
|
|
154
|
+
adapter is the default** — if you have Node/npx and are logged into Claude Code,
|
|
155
|
+
`ghx sidecar ask` works out of the box. Write an explicit config only to pin a
|
|
156
|
+
different agent or model:
|
|
155
157
|
|
|
156
158
|
```bash
|
|
157
159
|
ghx sidecar config init --claude-acp # writes ~/.ghx/config.json with the ACP adapter
|
|
158
160
|
```
|
|
159
161
|
|
|
160
|
-
>
|
|
161
|
-
>
|
|
162
|
-
>
|
|
163
|
-
> rejected on purpose (it would hang every turn — see
|
|
162
|
+
> Without `--claude-acp`, `config init` auto-detects any ACP-capable agent
|
|
163
|
+
> already on your PATH; a bare `claude` binary does **not** speak ACP on stdio
|
|
164
|
+
> and is rejected on purpose (it would hang every turn — see
|
|
164
165
|
> [ADR-0019](docs/adr/0019-sidecar-adoption-zero-cli-surface.md) D4).
|
|
165
166
|
|
|
166
167
|
Re-running `config init --claude-acp` against an existing config shows a field
|
|
@@ -267,7 +268,7 @@ A main agent talks to the sidecar through a single MCP tool — one tool it cann
|
|
|
267
268
|
be tempted into step-driving:
|
|
268
269
|
|
|
269
270
|
```bash
|
|
270
|
-
ghx serve --recon # exposes exactly one MCP tool: recon(question, repo
|
|
271
|
+
ghx serve --recon # exposes exactly one MCP tool: recon(question, repo?, session?)
|
|
271
272
|
```
|
|
272
273
|
|
|
273
274
|
The recommended skill for agents is the concise recon skill (`ghx skill --recon`,
|
|
@@ -319,7 +320,7 @@ matching files. Same command, always useful output.
|
|
|
319
320
|
### Commands
|
|
320
321
|
|
|
321
322
|
```bash
|
|
322
|
-
ghx --version # Health check / installed version
|
|
323
|
+
ghx --version # Health check / installed version (also: ghx version)
|
|
323
324
|
ghx explore <owner/repo> # Compact branch + tree + README orientation
|
|
324
325
|
ghx explore <owner/repo> --full # Complete legacy explore output
|
|
325
326
|
ghx explore <owner/repo> <path> # Compact subdirectory listing
|
|
@@ -338,11 +339,36 @@ ghx search <owner/repo> "func main" # Repo-first code search, auto-quote
|
|
|
338
339
|
ghx search <owner/repo> "router" --lang go # Narrow by language
|
|
339
340
|
ghx search <owner/repo> "router" --glob "**/*.go" # Narrow by path glob
|
|
340
341
|
ghx search "repo:gkoreli/ghx cobra.Command" # Advanced raw GitHub code-search query
|
|
342
|
+
ghx inspect <owner/repo> "routing middleware" # Concern-driven search + ranked files, maps, snippets
|
|
341
343
|
ghx grep <owner/repo> "func main" # Grep-like repo search
|
|
342
344
|
ghx grep <owner/repo> "RunE" --path internal/cli --limit 10
|
|
343
345
|
ghx repos "<query>" # Repo search with README preview
|
|
344
346
|
ghx tree <owner/repo> [path] # Full recursive tree
|
|
345
347
|
ghx tree <owner/repo> [path] --depth N # Tree limited to N levels
|
|
348
|
+
ghx code "<js>" # Execute JS with access to all ghx tools
|
|
349
|
+
ghx code --list # List available tools with type stubs
|
|
350
|
+
ghx serve # Start the direct-tools MCP server (stdio)
|
|
351
|
+
ghx serve --http :8080 # Serve MCP over streamable HTTP
|
|
352
|
+
ghx serve --recon # Start the single-tool recon MCP service
|
|
353
|
+
ghx skill # Print the classic CLI skill
|
|
354
|
+
ghx skill --mcp # Print the classic MCP skill
|
|
355
|
+
ghx skill --recon # Print the concise recon skill
|
|
356
|
+
ghx sidecar config init --claude-acp # Write ~/.ghx/config.json for Claude ACP
|
|
357
|
+
ghx sidecar config show # Show resolved sidecar config
|
|
358
|
+
ghx sidecar doctor # Verify token, network, ghx binary, ACP, report sink
|
|
359
|
+
ghx sidecar doctor --live # Run a real one-prompt ACP turn for diagnosis
|
|
360
|
+
ghx sidecar ask --repo <owner/repo> "<q>" # Delegate one repo question to the sidecar
|
|
361
|
+
ghx sidecar ask "<q>" # Discovery question across GitHub
|
|
362
|
+
ghx sidecar ask --repo <o/r> --local "<q>" # Also allow tier-2 local analysis (codemap/ast-grep/repomap)
|
|
363
|
+
ghx sidecar daemon --status # Inspect the warm sidecar daemon
|
|
364
|
+
ghx sidecar daemon --stop # Stop the warm sidecar daemon
|
|
365
|
+
ghx sidecar sessions list # List persisted sidecar sessions
|
|
366
|
+
ghx sidecar sessions show <session> # Metadata + report history
|
|
367
|
+
ghx sidecar sessions ledger <session> # Accumulated evidence ledger JSON
|
|
368
|
+
ghx sidecar sessions reroute <s> <turn> <dest> # Move a mis-routed turn and rebuild ledgers
|
|
369
|
+
ghx sidecar view [session] # Local OTel viewer over session artifacts
|
|
370
|
+
ghx sidecar evals export --format sft --run <dir> --out <file> # Export committed eval episodes
|
|
371
|
+
ghx sidecar report-sink --out <path> # Internal report-sink MCP server used by ACP turns
|
|
346
372
|
ghx tier2 codemap <owner/repo> # Tier-2 cross-file structure as JSON (local snapshot)
|
|
347
373
|
ghx tier2 codemap <owner/repo> --context # Agent-ready JSON context envelope (--compact to shrink)
|
|
348
374
|
ghx tier2 codemap <owner/repo> --importers <file> # Who imports a file (fan-in; needs ast-grep)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@gkoreli/ghx",
|
|
3
|
-
"version": "2.4.
|
|
3
|
+
"version": "2.4.2",
|
|
4
4
|
"description": "Agent-first GitHub code exploration. GraphQL batching, code maps, codemode TypeScript sandbox, MCP server.",
|
|
5
5
|
"bin": {
|
|
6
6
|
"ghx": "npm/bin/ghx"
|
|
@@ -28,11 +28,11 @@
|
|
|
28
28
|
"node": ">=16"
|
|
29
29
|
},
|
|
30
30
|
"optionalDependencies": {
|
|
31
|
-
"@gkoreli/ghx-darwin-arm64": "2.4.
|
|
32
|
-
"@gkoreli/ghx-darwin-x64": "2.4.
|
|
33
|
-
"@gkoreli/ghx-linux-arm64": "2.4.
|
|
34
|
-
"@gkoreli/ghx-linux-x64": "2.4.
|
|
35
|
-
"@gkoreli/ghx-win32-arm64": "2.4.
|
|
36
|
-
"@gkoreli/ghx-win32-x64": "2.4.
|
|
31
|
+
"@gkoreli/ghx-darwin-arm64": "2.4.2",
|
|
32
|
+
"@gkoreli/ghx-darwin-x64": "2.4.2",
|
|
33
|
+
"@gkoreli/ghx-linux-arm64": "2.4.2",
|
|
34
|
+
"@gkoreli/ghx-linux-x64": "2.4.2",
|
|
35
|
+
"@gkoreli/ghx-win32-arm64": "2.4.2",
|
|
36
|
+
"@gkoreli/ghx-win32-x64": "2.4.2"
|
|
37
37
|
}
|
|
38
38
|
}
|