@itsbjoern/roost

CLI and JavaScript API for Roost (local HTTPS reverse proxy with automatic cert management).

Install

npm install -g @itsbjoern/roost

Usage

roost init          # after global install
npx roost init      # without installing (npm)

If roost is not found after a global install, add your package manager's global bin to PATH (e.g. export PATH="$PATH:$(npm config get prefix)/bin" for npm, or export PATH="$PATH:$HOME/.bun/bin" for Bun).

JavaScript API

Use the package as a library to get cert/key contents (or paths) for HTTPS config. Use getDomainCerts for build tools—returns literal PEM strings, no file reads:

const { getDomainCerts } = require('@itsbjoern/roost');

const { cert, key } = await getDomainCerts('api.local', { generate: true });
// Pass cert and key directly to https.createServer or Vite server.https

See the main README for full API docs and examples.