{"_id":"@abzy128/cmdhelp","name":"@abzy128/cmdhelp","dist-tags":{"latest":"0.2.0"},"versions":{"0.2.0":{"name":"@abzy128/cmdhelp","version":"0.2.0","description":"Fast command suggestions and explanations for your shell","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"type":"module","packageManager":"bun@1.4.0","engines":{"bun":">=1.4.0"},"bin":{"cmdhelp":"bin/cmdhelp"},"repository":{"type":"git","url":"git+https://github.com/abzy128/cmdhelp.git"},"scripts":{"start":"bun src/cli.ts","check":"tsc --noEmit","test":"bun test","test:package":"bun scripts/check-package.ts","prepublishOnly":"bun run check && bun test"},"dependencies":{"@earendil-works/pi-ai":"0.85.1","@earendil-works/pi-tui":"0.85.1","proper-lockfile":"4.1.2"},"devDependencies":{"@types/bun":"^1.4.0","@types/proper-lockfile":"^4.1.4","typescript":"^5.9.0"},"gitHead":"31de5a1764e469cf8a887dfd5383ec5d3a859b1d","_id":"@abzy128/cmdhelp@0.2.0","bugs":{"url":"https://github.com/abzy128/cmdhelp/issues"},"homepage":"https://github.com/abzy128/cmdhelp#readme","_nodeVersion":"26.8.1","_npmVersion":"11.19.0","dist":{"integrity":"sha512-2yFB5XLtIPvmavEDhlqmgQUSdXJ4R3UD2nxs8vaBG+GUwO1HlWWyVksAhaukYVxuKaGOrxeB+1UdOvoO9Pv35A==","shasum":"4d1904bf6904086b8ad5705fdef94da2ee5039f1","tarball":"https://registry.npmjs.org/@abzy128/cmdhelp/-/cmdhelp-0.2.0.tgz","fileCount":13,"unpackedSize":35769,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIFBS80Ul2QGmq7EGusvXFT9AfHSZIc9aGi+TK7HHTyKnAiEAnuiqKO6MBR26ucP6M4oAwVnCqrcanICV0RSjzzRB8XQ="}]},"_npmUser":{"name":"abzy128","email":"abzalorazbek2003@gmail.com"},"directories":{},"maintainers":[{"name":"abzy128","email":"abzalorazbek2003@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cmdhelp_0.2.0_1788690673499_0.10940784676779214"},"_hasShrinkwrap":false}},"time":{"created":"2026-09-06T10:31:13.288Z","0.2.0":"2026-09-06T10:31:13.642Z","modified":"2026-09-06T10:31:13.884Z"},"maintainers":[{"name":"abzy128","email":"abzalorazbek2003@gmail.com"}],"description":"Fast command suggestions and explanations for your shell","homepage":"https://github.com/abzy128/cmdhelp#readme","repository":{"type":"git","url":"git+https://github.com/abzy128/cmdhelp.git"},"bugs":{"url":"https://github.com/abzy128/cmdhelp/issues"},"readme":"# cmdhelp\n\nCommand suggestions and explanations, one shortcut away in zsh.\n\nDescribe what you want to do, inspect the suggestion, and insert it into your shell prompt. Or paste a command and ask what it means. Responses stream into a small terminal panel, with follow-up questions and cancellation.\n\ncmdhelp uses Pi's model API directly. It does not launch a coding agent or execute generated commands.\n\n## Install\n\nRequires [Bun](https://bun.sh/docs/installation) 1.4+ and zsh on macOS or Linux.\n\n```sh\nbun add -g @abzy128/cmdhelp\n```\n\nMake sure Bun's executable directory (normally `~/.bun/bin`) is on `PATH`. Add this line to your zsh configuration, after other shell plugins:\n\n```zsh\neval \"$(cmdhelp init zsh)\"\n```\n\nRun the same line in your current shell to enable the shortcuts immediately. Configure a provider and model before making your first request.\n\n**[Installation guide](docs/installation.md)** · **[Configuration guide](docs/configuration.md)**\n\nYou can also install with `npm install -g @abzy128/cmdhelp`; Bun must still be installed and available on `PATH`.\n\n## Use\n\n| Shortcut | Action |\n| --- | --- |\n| Ctrl-X, Ctrl-G | Describe the command you need |\n| Ctrl-X, Ctrl-E | Explain the current shell input |\n| Enter | Submit a prompt, or insert a completed suggestion |\n| Tab | Ask a follow-up after an answer |\n| Up / Down | Scroll the answer |\n| Escape / Ctrl-C | Cancel and restore the original input |\n\nThe launch shortcuts are sequences: press Ctrl-X, then Ctrl-G or Ctrl-E. Suggestions are inserted for editing; running them requires a separate Enter at the shell prompt.\n\n```sh\ncmdhelp suggest 'find files larger than 100 MiB'\ncmdhelp explain 'git reset --soft HEAD~1'\ncmdhelp explain < command.txt\ncmdhelp doctor\n```\n\nQuote command arguments literally to prevent your shell from expanding `$()`, backticks, pipes, or redirections. Pipe command text on stdin when quoting is inconvenient.\n\n## Configuration\n\nThe default file is `~/.config/cmdhelp/config.json`, or `$XDG_CONFIG_HOME/cmdhelp/config.json`.\n\nIf Pi already has a default provider/model and saved credentials, cmdhelp uses them. Its default profile is `~/.pi/agent`; reasoning defaults to `off` independently of Pi's setting.\n\n```json\n{\n  \"reasoning\": \"low\",\n  \"timeoutMs\": 30000\n}\n```\n\nYou can also select a provider/model explicitly, use a custom Pi profile, or authenticate with a provider API-key environment variable. See the [configuration guide](docs/configuration.md) for examples and precedence.\n\n## Data and behavior\n\nRequests include your prompt, current shell input when using a widget, OS/shell identity, and recent follow-ups within the panel. cmdhelp does not send project files, shell history, or an environment dump as prompt context. Conversations are not saved. Temporary shell handoff files are private and removed when the widget exits normally or is cancelled.\n\nCredentials remain in Pi's auth file; OAuth refresh may update them. Built-in Pi providers and cached catalogs are supported. Custom `models.json` providers and extension-defined providers are not loaded. Generated commands remain suggestions and can be incorrect.\n\n## Development\n\n```sh\nbun install --frozen-lockfile\nbun run check\nbun test\nzsh -n shell/cmdhelp.zsh\n```\n\nRun `bun run start --help` during development. See [installation](docs/installation.md#verification) for the pseudo-terminal integration check.\n\nRun `bun run test:package` to pack and install the npm tarball in a temporary directory (requires npm and registry access). See [publishing](docs/publishing.md) for npm setup and releases.\n","readmeFilename":"README.md","_rev":"1-ea1df7676795e82c139472f5567be405"}