Skip to content

yetanotheraryan/goodtogo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

goodtogo

Zero-config dev environment readiness checker. · website

NPM Version GitHub package.json version GitHub Repo stars GitHub last commit GitHub contributors GitHub forks GitHub License

$ npx goodtogo

  goodtogo

  ✓ node runtime      — v20.11.0 satisfies >=18
  ✓ port 5432         — port is occupied, service is up
  ✗ port 6379         — nothing is listening on this port
    → Run: docker compose up -d redis
  ✓ DATABASE_URL      — set
  ✗ JWT_SECRET        — not set in .env or environment
    → Add JWT_SECRET=... to your .env file
  ⚠ REDIS_URL         — set but empty
    → Set a value for REDIS_URL in your .env file

  3 passed · 2 failed · 1 warning

install

npm install -g goodtogo

or run without installing:

npx goodtogo

what gets checked

file what's verified
.env.example required env vars present and non-empty in .env / process.env
docker-compose.yml host ports occupied — services are running
package.json node/npm version satisfies the engines field
Dockerfile runtime versions (node, go, python, java) match what's installed

No config file needed. goodtogo auto-detects what your project has and runs only the relevant checks.

flags

--ci           exit 1 on any failure
--json, -j     machine-readable JSON output
--verbose, -v  show detail on passing checks
--version, -V  print version
--help, -h     show help

json output for AI Agents or Bots

goodtogo --json
{
  "summary": { "passed": 3, "failed": 2, "warned": 1 },
  "results": [
    { "label": "node runtime", "status": "pass", "detail": "v20.11.0 satisfies >=18" },
    { "label": "JWT_SECRET", "status": "fail", "detail": "not set in .env or environment", "fix": "Add JWT_SECRET=... to your .env file" }
  ]
}

requirements

  • Node.js >=18
  • Zero runtime dependencies

contributing

PRs welcome. Open an issue first for anything beyond small fixes.

git clone https://github.com/yetanotheraryan/goodtogo
cd goodtogo
npm install
npm run build
node bin/cli.js

license

MIT © yetanotheraryan

About

Zero-config dev environment readiness checker. Scans your project and verifies services, ports, env vars, and runtime versions before you hit cryptic errors.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors