Skip to content

ran4om/vibe-check

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

18 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿ”ฎ 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

About

Give any API a personality report ๐Ÿ”ฎ โ€” One command, one URL, one vibe.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors