Find code by asking what it does. A CLI for coding agents that uses Jev to discover relevant files and source context.
TypeScript ai-sdkclaude-codeclicode-searchcodexcoding-agentscontext-retrievaldeveloper-toolsjevsemantic-searchtypescriptvercel-ai-gateway
docs: lead skill installation with jg skill and let the installer detect agents
David Zhang3cd6dc885da9
diff --git a/README.md b/README.mdindex 00afbe0..4b9d6c4 100644--- a/README.md+++ b/README.md@@ -18,7 +18,7 @@ folders, files, and declarations. Your coding agent then implements and tests th```shnpm install -g @dzhng/jevgrepjg auth-npx skills add dzhng/jevgrep --skill jevgrep --agent codex --agent claude-code+jg skilljg "How are telemetry events recorded and sent?" ./my-project```@@ -31,26 +31,27 @@ Installing the CLI alone does not teach your coding agent to use it. **Installthe skill as well**, from the project where your agent works:```sh-npx skills add dzhng/jevgrep --skill jevgrep --agent codex --agent claude-code+jg skill```-Select just the agent you use, or add `--global` for a user-wide install. The+The installer detects your coding agents (Claude Code, Codex, OpenCode and+others) and asks where to install. Add `--global` for a user-wide install, or+`--yes` for unattended installation. The[skill](skills/jevgrep/SKILL.md) teaches the agent when to call `jg`, how to usereturned context, and when to fill gaps with its normal tools. It skips redundantretrieval when the needed context is already known. The current repository skillchecks for `jg` and installs the CLI if it is missing; authentication still needsyour Gateway key. The skill installer itself does not configure credentials.-The CLI also provides a shortcut to the same installer:+`jg skill` delegates to the [skills CLI](https://github.com/vercel-labs/skills)+and needs npm/npx plus network access. You can also run that installer directly,+without the CLI installed:```sh-jg skill # interactive agent selection-jg skill --agent codex --global # install for Codex across projects+npx skills add dzhng/jevgrep --skill jevgrep```-`jg skill` delegates to `npx skills add dzhng/jevgrep --skill jevgrep` and needs-npm/npx plus network access. Add `--yes` for unattended installation. In 0.1.0,-`jg skill` only prints the bundled skill; use `npx skills` directly with that version.+In 0.1.0, `jg skill` only prints the bundled skill; use `npx skills` with that version.### Upgrade@@ -61,8 +62,7 @@ npm install -g @dzhng/jevgrep@latestjg --version```-Update the installed skill separately by rerunning the `npx skills add` command-above. Updating the npm package does not+Update the installed skill separately by rerunning `jg skill`. Updating the npm package does notoverwrite skill files in your projects. See the [package guide](apps/cli/README.md)for authentication details.diff --git a/apps/cli/README.md b/apps/cli/README.mdindex 4edda51..6db4dcd 100644--- a/apps/cli/README.md+++ b/apps/cli/README.md@@ -31,20 +31,24 @@ Application output goes to stdout; `jg` does not create a report file.Install the canonical skill into the project where your coding agent works:```sh-npx skills add dzhng/jevgrep --skill jevgrep --agent codex --agent claude-code+jg skill+```++The installer detects your coding agents (Claude Code, Codex, OpenCode and+others) and asks where to install. `jg skill` also accepts `--agent NAME`+(repeatable), `--global`, and `--yes`; these options come from the+[skills CLI](https://github.com/vercel-labs/skills#install-a-skill), which it+delegates to, so it requires npm/npx and network access. You can run that+installer directly as well:++```sh+npx skills add dzhng/jevgrep --skill jevgrep```-Select only the agent you use, or add `--global` for user-wide installation. These-options come from the [skills CLI](https://github.com/vercel-labs/skills#install-a-skill).Installing the skill does not install the `jg` executable or configure its key.The current repository skill installs a missing CLI when the agent first uses it;-0.1.0's bundled skill predates that setup step. Use the repository skill-installer above for the latest instructions.--`jg skill` is a shortcut to that same installer. It supports-`--agent NAME` (repeatable), `--global`, and `--yes`; without options, the installer-prompts for settings. It requires npm/npx and network access. Published 0.1.0's-`jg skill` still prints text, so use `npx skills` directly with that version.+0.1.0's bundled skill predates that setup step, and its `jg skill` only prints+text, so use `npx skills` directly with that version.Search does not install skills or edit agent configuration. Only an explicitskill installation command invokes the installer. The skill directs the agent@@ -52,7 +56,7 @@ to read returned excerpts before further discovery, skip redundant searches whenthe needed context is already known, and handle incomplete results honestly.There is no built-in upgrade command. Use `npm install --global @dzhng/jevgrep@latest`-to upgrade the CLI, then rerun your `npx skills add` command to update+to upgrade the CLI, then rerun `jg skill` to updatethe agent's copy too.See the [repository](https://github.com/dzhng/jevgrep) for architecture, official