Skip to main content

Installation

Install bgng from the CLI package in this repository, then verify the binary is on your PATH.

Requirements​

  • Node.js 22 or newer.
  • A terminal with access to this repository.
  • A SupaData API key if you plan to capture YouTube transcripts.

The CLI itself is pure Node. Docker, Cargo, and external local services are not required for the personal knowledge-base workflow.

cd /path/to/beginning-db/apps/cli
npm install
npm run link

npm run link builds the TypeScript output and links both bgng and bgng-db globally. They point at the same compiled binary; use bgng in new scripts and docs.

Verify:

bgng --version
# bgng 0.1.0

If global linking fails with a permissions error, configure npm to use a user-local prefix or use Bun if it is already installed:

npm config set prefix ~/.local
# or
bun run link

What is installed​

The linked binary runs apps/cli/dist/bin/bgng.js, sourced from apps/cli/bin/bgng.ts. On startup it loads a local .env file if one exists, then hands arguments to clipanion.