prereq-cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,177 @@
+# prereq-cli
+
+Colorful prerequisite auditor for large codebases.
+
+Use it to define a curated list of CLIs/apps your project needs (Bun, Docker, mongosh, etc), then check whether a machine or remote agent has them installed and on the expected version.
+
+## Install
+
+```bash
+# npm
+npm i -D prereq-cli
+
+# bun
+bun add -d prereq-cli
+```
+
+## Run
+
+```bash
+# default check (discovers prereq.config.ts/json)
+npx prereq
+
+# bunx
+bunx prereq
+
+# explicit config path
+npx prereq --config ./infra/prereq.config.ts
+
+# strict mode: fail on required outdated/version_unknown too
+npx prereq --strict
+
+# verbose mode (show all details for every prerequisite)
+npx prereq --verbose
+
+# machine-readable output
+npx prereq --json
+```
+
+## Commands
+
+- `prereq` or `prereq check` - run prerequisite checks
+- `prereq validate` - validate config only (no checks)
+- `prereq init` - scaffold starter config
+- `prereq list-examples` - show bundled config examples
+
+## Examples
+
+See curated config sets in `examples/`:
+
+- `examples/basic-ts/`
+- `examples/basic-json/`
+- `examples/monorepo-membrane-style/`
+- `examples/remote-agent-ubuntu/`
+- `examples/k8s-platform/`
+- `examples/release-ops/`
+- `examples/desktop-secrets-vpn/`
+
+## Check Options
+
+- `-c, --config <path>` config file path
+- `--json` output JSON
+- `--verbose` show full details for all prerequisites
+- `--strict` fail on required outdated/version_unknown
+- `--required-only` only evaluate required prerequisites
+- `--timeout <ms>` per-command timeout (default `4000`)
+- `--concurrency <n>` max concurrent checks (default `8`)
+- `--cwd <path>` working directory to resolve config path (default `.`)
+- `--no-color` disable ANSI colors
+
+## Config File
+
+Supported formats:
+
+- `prereq.config.ts`
+- `prereq.config.mts`
+- `prereq.config.cts`
+- `prereq.config.js`
+- `prereq.config.mjs`
+- `prereq.config.cjs`
+- `prereq.config.json`
+
+### TypeScript config
+
+```ts
+import { defineConfig } from 'prereq-cli'
+
+export default defineConfig({
+  projectName: 'my-monorepo',
+  prerequisites: [
+    {
+      id: 'bun',
+      name: 'Bun',
+      tier: 'required',
+      detect: {
+        binaries: ['bun'],
+      },
+      version: {
+        command: 'bun --version',
+        range: '>=1.3.10',
+      },
+      docs: 'https://bun.com/docs/installation',
+      install: {
+        darwin: ['curl -fsSL https://bun.sh/install | bash'],
+        linux: ['curl -fsSL https://bun.sh/install | bash'],
+      },
+    },
+    {
+      id: 'docker',
+      tier: 'required',
+      detect: {
+        binaries: ['docker'],
+        commands: ['docker info >/dev/null 2>&1'],
+      },
+      docs: {
+        install: 'https://docs.docker.com/get-started/introduction/get-docker-desktop/',
+      },
+      install: 'brew install --cask docker',
+    },
+  ],
+})
+```
+
+### JSON config
+
+```json
+{
+  "projectName": "my-monorepo",
+  "prerequisites": [
+    {
+      "id": "node",
+      "tier": "required",
+      "detect": { "binaries": ["node"] },
+      "version": { "command": "node --version", "range": ">=20.0.0" }
+    }
+  ]
+}
+```
+
+## Result Statuses
+
+- `ok` - prerequisite detected (and version satisfied, if configured)
+- `missing` - not detected
+- `outdated` - detected but version does not satisfy range
+- `version_unknown` - detected but version command output could not be evaluated
+
+## Programmatic Config Helper
+
+```ts
+import { defineConfig } from 'prereq-cli/config'
+```
+
+## Development
+
+```bash
+bun install
+bun run build
+bun run test
+bun run check
+```
+
+## Publishing
+
+```bash
+# 1) full quality gate + tarball preview
+bun run pack:dry-run
+
+# 2) full quality gate + npm publish dry-run
+bun run publish:dry-run
+
+# 3) publish publicly
+bun run publish:public
+```
+
+Notes:
+
+- package name check: `bunx npm view prereq-cli version`
+- login check: `bunx npm whoami`

package/dist/checker.d.ts

@@ -0,0 +1,2 @@
+import type { AuditReport, NormalizedConfig, RunOptions } from './types';
+export declare function runAudit(config: NormalizedConfig, configPath: string, options: RunOptions): Promise<AuditReport>;

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};