⚡ run-ready

Any repo. One command. It just runs.

npx run-ready https://github.com/vercel/next.js

✨ What it does

1. Smart Clone

Paste any GitHub link. It shallow clones with --depth 1 for speed.
No git? Falls back to zip download. Auto cds into the project.

2. Env Detective

Scans your entire codebase for process.env.*, import.meta.env.*, os.getenv() and generates a perfect .env.example.
No more guessing env vars from broken docs.

3. System Doctor

Cross-platform checks:

• ✔️ Node version vs package.json engines
• ✔️ Port 3000 / 8000 busy?
• ✔️ Package manager detection (pnpm, yarn, npm)
• ✔️ docker-compose.yml found but not running?

4. Auto Fix

One flag to fix it all.

rr --fix
# ✔ Created .env from .env.example
# ✔ Started docker compose services
# ✔ All set! Run: pnpm dev

🚀 Install

No install needed. Use directly:

npx run-ready https://github.com/vercel/next.js

Or install globally:

npm i -g run-ready
rr https://github.com/vercel/next.js

You get two commands: run-ready and short rr

📖 Commands

rr <github-url>   # Clone + Scan + Check (the magic)
rr --check        # Check health of current repo
rr --fix          # Auto-fix all issues (.env, docker)
rr --env          # Only generate .env.example
rr --help         # Help

Examples

# Clone express and make it ready
rr https://github.com/expressjs/express

# You are already inside a project, just check it
cd my-project
rr --check

# It found issues, fix them
rr --fix

🛠️ Output Example

⚡ run-ready  —  Any repo. One command. It just runs.

√ Cloned express
✔ Ready in C:\Users\HOME\Desktop\run ready\express

√ Found 2 env vars: NODE_ENV, NO_DEPRECATION
✔ Generated .env.example

✔ Node v24.12.0 (requires >= 18)
✔ Port 3000 is free
⚠ Package manager: No lock file found

Why?

I built this because I was tired of cloning cool GitHub repos and spending an hour just to run them.
READMEs lie. Env vars are hidden. Docker is always down.

This is for developers, by a developer.

Tech Stack

• TypeScript + Node.js — ESM, fully typed, strict mode
• Zero config — works on Windows / Mac / Linux
• commander — CLI framework
• chalk — terminal colors
• ora — spinners
• glob — file scanning
• adm-zip — zip extraction fallback

🤝 Contributing

PRs welcome! This is MIT licensed.

# Fork it, then:
git clone https://github.com/vinyassystems/Run_Ready
cd Run_Ready
npm install
npm run build
node dist/index.js --check

⭐ Star History

If this saved you 30 minutes, give it a star ⭐

Built by Vinyas Poojary — 19, building tools for devs.