🔮 vibe-check

Give any API a personality report.

One command. One URL. One vibe.

npx @ran4om/vibe-check https://api.example.com/users

or with Bun:

bunx vibe-check https://api.example.com/users

What is this?

Point vibe-check at any API endpoint, and instead of boring technical metrics, you get a personality report — a fun, opinionated verdict on whether that API is trustworthy, bloated, fast, moody, or just cooked.

Think of it like a code linter, but for API behavior. Instead of just showing numbers, it gives you a character assessment.

The Verdict Labels

| Score | Label | Emoji | Meaning | |-------|-------|-------|---------| | 80–100 | Snappy | ⚡ | Fast, reliable, well-mannered. | | 60–79 | Chill | 😎 | Gets the job done, no drama. | | 45–59 | Chunky | 🧱 | It works, but it's carrying extra weight. | | 30–44 | Sleepy | 😴 | Needs a coffee and a stern talk. | | 15–29 | Chaotic | 🌀 | A gambling experience for your users. | | 0–14 | Cooked | 💀 | Thoughts and prayers. |

What it analyzes

• ⚡ Speed — Response times (avg, p50, p95)
• 📏 Consistency — Variance and reliability across requests
• 📦 Size — Payload bloat and compression
• 🪟 Honesty — Are status codes truthful?
• 🏰 Headers — Security posture and best practices

Usage

# Basic usage
npx @ran4om/vibe-check https://api.example.com/endpoint

# Custom request count
npx @ran4om/vibe-check https://api.example.com/endpoint --requests 50

# POST request with body
npx @ran4om/vibe-check https://api.example.com/create -m POST -b '{"name": "test"}'

# Add custom headers
npx @ran4om/vibe-check https://api.example.com/secure -H "Authorization: Bearer token123"

# Get raw JSON output
npx @ran4om/vibe-check https://api.example.com/endpoint --json

# Share via GitHub Gist
npx @ran4om/vibe-check https://api.example.com/endpoint --gist

Options

| Flag | Description | Default | |------|-------------|---------| | -n, --requests <n> | Number of requests to fire | 20 | | -m, --method <method> | HTTP method | GET | | -H, --header <header> | Custom headers (repeatable) | — | | -b, --body <json> | Request body (JSON) | — | | -t, --timeout <ms> | Request timeout | 10000 | | --json | Output raw JSON | — | | --gist | Also share via GitHub Gist | — | | --no-color | Disable colors | — |

Sharing

Every vibe-check generates a shareable link automatically:

🔗 Share → https://api-vibecheck.vercel.app/#u=httpbin.org%2Fget&v=4&s=75,20,100,100,50&t=442,197,640,394&r=16

The link opens a beautiful web report card — no account needed, no backend, just a static page that reconstructs the report from the URL.

Want a GitHub Gist instead? Use --gist (requires GitHub CLI):

npx @ran4om/vibe-check https://api.example.com/endpoint --gist
# → Gist → https://gist.github.com/abc123

Use Cases

• Evaluating third-party APIs before committing to them
• Debugging staging environments — why does this feel slow?
• Sanity-checking your own service before launching
• PR comments — drop a vibe report when changing API behavior
• Bragging rights — post your API's ✨ Immaculate score

Requirements

• Node.js >= 18 or Bun

License

MIT