Skip to content
VibeBeacon

Getting started

Three things: sign in, create a key, send us your stack. It takes about two minutes and you never give us access to anything.

1. Sign in

There are no passwords. Enter your email and we send a link, or sign in with GitHub. The GitHub scope covers your email address only, and we never ask for repository access.

2. Create an API key

Keys live under Settings, API keys. A key belongs to you, not to a single app, so one key can upload for every app you run. It is shown once. We store a SHA-256 hash and the first 14 characters so you can tell your keys apart.

  • Keys start with vb_live_ followed by 40 characters.
  • Put it in an environment variable called VIBEBEACON_API_KEY, or pass it with --key.
  • Lost it? Revoke and make a new one. We cannot show it again.

3. Send us your stack

All three paths produce the same file, a short list of runtimes, frameworks, dependencies and services with versions. Pick whichever your tool supports.

Run this in the project folder. Node 20 or newer. Nothing is installed permanently.

bash
npx vibebeacon@latest scan --upload --key vb_live_your_key_here

Full flag list on the CLI page.

4. Check the result

The upload runs a match straight away, so the dashboard is populated by the time the command finishes. You will see the parsed stack, any open alerts and the age of the manifest.

No alerts is a normal result

Most stacks are clean on day one. The value shows up in week three when something lands on a version you run and the email arrives before you would have noticed.

5. Keep it fresh

A manifest goes stale as soon as you upgrade something. Three ways to keep it current, cheapest first.

  1. Do nothing. We email you when a manifest is older than 30 days.
  2. Run the CLI with --watch while you work.
  3. Add the GitHub Action so every push updates it.

6. Turn the volume where you want it

By default you get an instant email for high and critical problems that match an exact version you run, a daily digest for the rest, and news items weekly. Change the threshold per app under Settings, or read alerts and digests first.