Beginning CLI
bgng is a single TypeScript CLI for three BeginningDB-adjacent workflows: capturing and searching a local transcript knowledge base, managing IDE profiles for the BeginningDB VSCode extension, and operating direct BeginningDB or S3 adapter admin surfaces.
The command name is bgng. The package version documented here is 0.1.0, and the CLI runtime requires Node.js 22 or newer.
The three surfaces
| Surface | Use it for | Start here |
|---|---|---|
| Personal knowledge base | Capture YouTube transcripts, import notes, index with qmd, search with BM25 or hybrid search | First Run |
| IDE control plane | Install the VSCode extension, define profiles, store auth, open a workspace | IDE Control Plane |
| Direct admin | Use bgng db against BeginningDB or bgng s3 against the S3 adapter admin API | Direct BeginningDB |
First commands
cd apps/cli
npm run link
bgng --version
bgng init
If your immediate goal is transcript search, continue with First Run. If you already know which surface you need, use Choose Your Path.
State and safety
The CLI keeps local state under ~/.bgng/ unless BGNG_HOME is set. That workspace contains config, transcripts, qmd index files, queue state, and IDE profile/auth state. There is no telemetry or remote logging; network calls happen only when a command needs SupaData, BeginningDB, a gateway worker, or the S3 adapter.
Auth material is plain JSON on disk. Treat ~/.bgng/ as sensitive and do not sync it to public storage.