Skip to content
brignanoPublic

About

npx brignano — an interactive terminal business card: live GitHub stats, quick links, vCard, and a scannable QR code.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

npx brignano

npm version npm downloads CI license

An interactive terminal business card for Anthony Brignano. Run it with npx to get an animated, centered ASCII-art intro, a styled card with live GitHub stats, and quick actions — copy my email, open my socials, save my contact, or grab a scannable QR code.

Quick start

npx brignano

What it does

  • Animated splash (figlet + chalk): a light sweeps across the lettering to reveal the larch-amber monogram, a glint follows, and a tagline fades in beneath. Everything is centered on your terminal, and the banner steps down to a smaller font on narrow windows.
  • Styled business card (boxen + chalk) with name, role, links and email, revealed line by line under the banner.
  • Live GitHub stats — follower/repo counts and my latest repo, fetched fresh with a strict ~1.5s timeout. If the network is slow or offline, the card renders instantly and just omits the live line. It never hangs.
  • Interactive menu (inquirer) that comes back after each action, so you can do several things in one sitting:
    • Copy my email to your clipboard
    • Send me an email (mailto:)
    • Open my GitHub / LinkedIn
    • View my resume
    • Save my contact as a .vcf (opens in Contacts)
    • Show a scannable contact QR code
    • Quit (or press Ctrl+C at any time)

The animation, network fetch, and prompt are all skipped automatically when output isn't a TTY (piped, CI, or --no-prompt), so it stays fast and never blocks scripts.

Design

Colours come from @brignano/design, the shared design system behind brignano.io, and follow its "one hue, one meaning" rule: the banner is the monogram and takes the larch-amber mark; anything you can act on (links, the selected menu row) is cobalt; confirmations are forest, failures are rust, and everything else sits on the neutral ramp. Cobalt is always drawn as text, so it uses the two ink steps: links and the rows beside the selected one take --i-ink, and the selected row takes --i-ink-hover. The fill steps (--i, --i-hover, --i-pressed) are not used: they are too deep to read on a dark terminal. The hex values live in one place, src/tokens.ts, named after the CSS custom properties they mirror; at startup the card asks the terminal for its background colour (OSC 11) and picks the light set when it is light. A terminal that doesn't answer within 100 ms falls back to COLORFGBG, then to the dark set; piped output and CI are never asked.

Icons come in three tiers so nothing ever renders as an empty box: full Unicode where the terminal supports it; a set drawn from the blocks the legacy Windows console's font does cover (it draws ★, › and arrows fine, just not ❯ or ✔); and plain ASCII on the Linux kernel console.

CLI

Run npx brignano --help to see this list.

Flag Description
-h, --help Show help and exit.
-v, --version Print the installed version and exit.
-r, --view / --resume Open my resume in your default browser (https://brignano.io/resume).
-e, --email Open your mail client with a new message to hi@brignano.io.
--qr Print a scannable QR code to my website and exit.
--vcard / --save-contact Save my contact card (.vcf) and open it.
--no-animation Render the full card instantly, skipping the reveal animation.
--no-prompt Show the card only and exit (non-interactive).
-d, --download Deprecated alias for --view.

Unrecognized flags exit with a non-zero status instead of silently falling back to the default card.

Note: as of 2.0.0, -v prints the version (the near-universal CLI convention). The resume now lives at -r, and the long --view flag is unchanged.

Examples

npx brignano              # full interactive experience
npx brignano --view       # jump straight to my resume
npx brignano --version    # print the version
npx brignano --qr         # print a QR code to my site
npx brignano --vcard      # save my contact card
npx brignano --no-prompt  # card only (useful in CI/scripts)

Local development

git clone https://github.com/brignano/card.git
cd card
npm install
npm run build
node dist/card.js

Running it inside this repo: npx brignano resolves to this package's bin (dist/), not the published one — and dist/ is gitignored. On a fresh clone it will exit silently until you build. Use npm run dev (runs the TypeScript directly, no build step), or npm run build first. To exercise the published package instead, run npx brignano from any other directory.

The recording in demo.gif is produced by vhs/demo.tape. Re-record it from the Actions tab (Demo GIF → Run workflow) after a visual change lands; the workflow renders it on a Linux runner and pushes the new file back, so VHS doesn't need to be installed locally.

Source lives in src/ (split into small modules — card.ts is the entry/bin target). npm run build type-checks with tsc, then bundles with esbuild into dist/ (scripts/build.mjs). npm run dev runs the TypeScript directly (Node strips the types itself); npm run lint and npm run format use Biome.

The published package has no runtime dependencies: everything is bundled, so npx brignano downloads one small tarball instead of installing a dependency tree. Three things keep it that way:

  • The banner lettering is rendered once by figlet into src/bannerArt.ts (npm run gen:banner) and committed, so figlet and its fonts never ship. A test fails if that file drifts from what figlet produces.
  • The clipboard, browser-opener and QR libraries are split into their own chunks and only read when an action needs them.
  • test/pack.test.ts packs the tarball, unpacks it with no node_modules in reach, and runs it, so a missing import can't reach npm.

The licences of the bundled packages ship in dist/THIRD-PARTY-LICENSES.txt.

Prerequisites

  • Node.js >=22.18 (npx ships with npm). CI tests 22, 24 and 26.

Notes

  • Links in the card are real terminal hyperlinks (OSC 8) where the terminal supports them, so the email opens your mail client and the latest-repo name opens the repo. Piped output, NO_COLOR, CI and consoles without full Unicode get the plain text, unchanged.
  • The --download flag is deprecated and now opens the resume in your browser instead of writing a local file.

Credits

Inspired by anmol098/npx_card.

License

ISC © Anthony Brignano

About

npx brignano — an interactive terminal business card: live GitHub stats, quick links, vCard, and a scannable QR code.

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages