Skip to main content

Choose Your Path

bgng has one binary and three command surfaces. You do not need to learn all of them at once.

I want a searchable transcript and notes library​

Start with the personal knowledge-base surface.

bgng init
bgng url "<youtube-url>"
bgng query "what did the speaker say about indexes"

This path uses SupaData for transcript capture, stores files under ~/.bgng/transcripts/, and indexes Markdown with qmd.

Go to Personal Knowledge Base.

I want VSCode connected to BeginningDB​

Start with the IDE control plane.

bgng ide install
bgng ide connect --mode beginningdb.direct --id local-dev --label "Local dev" --base-url http://127.0.0.1:8080 --tenant-id 1 --filesystem-id main
bgng ide login --profile local-dev --token "Bearer ..."
bgng ide open --profile local-dev --workspace "$PWD"

This path manages profiles and auth state under ~/.bgng/ide/. The VSCode extension consumes bgng ide profiles resolve --json.

Go to IDE Control Plane.

I want direct BeginningDB admin commands​

Use bgng db when you need low-level BeginningDB HTTP operations.

bgng db doctor --profile local-dev
bgng db stat / --profile local-dev
bgng db put /notes/hello.md --body "hello" --profile local-dev

Go to Direct BeginningDB.

I want S3 adapter admin commands​

Use bgng s3 to create, rotate, revoke, or inspect S3 adapter admin resources.

export BGDB_S3_ADAPTER_URL=http://127.0.0.1:19001
export BGDB_S3_ADAPTER_ADMIN_TOKEN=...
bgng s3 keys list

Go to S3 Adapter Admin.