{"_id":"@amar0204/repo-scout","name":"@amar0204/repo-scout","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@amar0204/repo-scout","version":"1.0.0","description":"Pre-flight checks for open source contributors. Run in any cloned repo to know exactly how to get started.","type":"module","bin":{"repo-scout":"bin/cli.js"},"main":"./lib/index.js","exports":{".":"./lib/index.js"},"engines":{"node":">=18.0.0"},"scripts":{"test":"node --test test/detect.test.js"},"keywords":["contributor","open-source","preflight","setup","onboarding","cli","developer-tools"],"license":"MIT","author":{"name":"amar0204"},"repository":{"type":"git","url":"git+https://github.com/AmarReddy4/repo-scout.git"},"bugs":{"url":"https://github.com/AmarReddy4/repo-scout/issues"},"homepage":"https://github.com/AmarReddy4/repo-scout#readme","_id":"@amar0204/repo-scout@1.0.0","gitHead":"98ae402897f44817bce2384bd1ec68b4bd65cf9d","_nodeVersion":"22.17.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-/PJV9P/iJjwCey9sELBcPNf/q4Cc32dK90gCcLPDfcDGpjVMWybpTg7erqeIjAHDsUrsrGgVn2Uj0x5FWV8faw==","shasum":"676a27259b52cdbb5e24dd1bd257ccafb72761e3","tarball":"https://registry.npmjs.org/@amar0204/repo-scout/-/repo-scout-1.0.0.tgz","fileCount":7,"unpackedSize":18567,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCsUTsF4wgKTE6q+fY9tz1jjey3y04uAXmOOw/eX+trOQIhANLRH0BVbRjPp2825Dzd/pTNVMIJjId3kDEY5RUrMQeH"}]},"_npmUser":{"name":"amar0204","email":"amarendarkanthala@gmail.com"},"directories":{},"maintainers":[{"name":"amar0204","email":"amarendarkanthala@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/repo-scout_1.0.0_1775778654796_0.2677989116739752"},"_hasShrinkwrap":false}},"time":{"created":"2026-04-09T23:50:54.643Z","1.0.0":"2026-04-09T23:50:54.949Z","modified":"2026-04-09T23:50:55.182Z"},"maintainers":[{"name":"amar0204","email":"amarendarkanthala@gmail.com"}],"description":"Pre-flight checks for open source contributors. Run in any cloned repo to know exactly how to get started.","homepage":"https://github.com/AmarReddy4/repo-scout#readme","keywords":["contributor","open-source","preflight","setup","onboarding","cli","developer-tools"],"repository":{"type":"git","url":"git+https://github.com/AmarReddy4/repo-scout.git"},"author":{"name":"amar0204"},"bugs":{"url":"https://github.com/AmarReddy4/repo-scout/issues"},"license":"MIT","readme":"# repo-scout\n\nPre-flight checks for open source contributors. Clone a repo, run one command, know exactly how to get started.\n\n## The problem\n\nYou clone a repo to contribute. Now you need to figure out: which package manager? What Node version? Is there an `.env.example` to copy? A CLA to sign? What's the test command?\n\nYou end up opening 4 different files before writing a single line of code.\n\n## The fix\n\n```\nnpx repo-scout\n```\n\nThat's it. Run it in any cloned Node.js project and get a full report.\n\n## What it checks\n\n- **Package manager** — detects from lockfile (`package-lock.json`, `yarn.lock`, `pnpm-lock.yaml`, `bun.lockb`) or `packageManager` field\n- **Node version** — reads `.nvmrc`, `.node-version`, `.tool-versions`, or `engines.node` and compares against your current version\n- **Environment files** — finds `.env.example` / `.env.sample` and tells you if you still need to create `.env`\n- **Contributing guide** — checks for `CONTRIBUTING.md` in common locations\n- **CLA / DCO** — detects Contributor License Agreements from config files, workflow files, and contributing docs\n- **Scripts** — extracts the install, build, test, and lint commands from `package.json`\n- **Git hooks** — detects husky, lefthook, lint-staged, simple-git-hooks\n- **License** — identifies the project license\n\n## Example output\n\n```\n  repo-scout — contributor pre-flight check\n\n  Project: express\n  Path:    /home/user/dev/express\n\n  ✓ Package manager: npm (from package-lock.json)\n  ✓ Node version: >=18.0.0 required — you have v22.17.1 (from package.json engines.node)\n  ⚠ Environment: .env.example found — copy to .env before starting\n  ✓ Contributing guide: CONTRIBUTING.md\n  ⚠ CLA signing may be required (mentioned in CONTRIBUTING.md)\n  ✓ License: MIT\n  → Git hooks: husky, lint-staged — will set up on install\n\n  Quick start:\n    npm install\n    npm run build\n    npm run test\n\n  Read CONTRIBUTING.md before submitting a PR.\n  Run: cp .env.example .env\n```\n\n## Install\n\nRun directly with npx (no install needed):\n\n```\nnpx repo-scout\n```\n\nOr install globally:\n\n```\nnpm install -g repo-scout\n```\n\n## Usage\n\n```\nrepo-scout [directory]\n```\n\nIf no directory is given, it checks the current working directory.\n\n## Programmatic API\n\n```js\nimport { detectAll, formatResults } from 'repo-scout';\n\nconst results = detectAll('/path/to/repo');\nconsole.log(formatResults(results, '/path/to/repo'));\n```\n\n## Exit codes\n\n- `0` — all checks passed\n- `1` — problems found (missing `package.json` or wrong Node version)\n\n## Zero dependencies\n\nrepo-scout uses only Node.js built-in modules. No `node_modules` bloat.\n\n## Requirements\n\nNode.js 18 or later.\n\n## License\n\nMIT\n","readmeFilename":"README.md","_rev":"1-a105b220c005426ceffdd21aa7f8c4f5"}