Skip to main content

Direct BeginningDB

bgng db is a direct HTTP client for BeginningDB. It maps CLI subcommands to BeginningDB file, stat, search, changes, and placements endpoints.

Choose a target

Explicit flags:

bgng db health --base-url http://127.0.0.1:8080 --tenant-id 1 --token "Bearer abc123" --filesystem-id main

Saved direct IDE profile:

bgng db health --profile local-dev
bgng db cat /readme.md --profile local-dev

Do not mix --profile with explicit connection flags. Gateway profiles are rejected because bgng db currently supports direct BeginningDB profiles only.

Path rewriting

When a target has a filesystem id, user paths are rewritten under /.bgdb-vfs/filesystems/<id>.

bgng db stat /readme.md --profile local-dev

Against filesystem main, that hits /.bgdb-vfs/filesystems/main/readme.md. Use --raw-paths when you need to bypass prefix rewriting.

Read and write

bgng db doctor --profile local-dev
bgng db stat / --profile local-dev
bgng db cat /readme.md --profile local-dev
bgng db put /notes/hello.md --body "hello" --profile local-dev
echo "from stdin" | bgng db put /piped.txt --profile local-dev
bgng db mkdir /folder --profile local-dev
bgng db rm /old.md --profile local-dev

db put reads --body first, then piped stdin. db mkdir accepts already-existing directories as success. db rm --everywhere forces delete-everywhere semantics.

Move, copy, and placements

bgng db mv /old.md /new.md --profile local-dev
bgng db cp /readme.md /readme.copy.md --profile local-dev
bgng db place /a/file.md /b/file.md --profile local-dev
bgng db unplace /b/file.md --profile local-dev
bgng db placements /a/file.md --profile local-dev

Copy and place operations work with BeginningDB placement semantics rather than ordinary byte-copy semantics.

Search and changes

bgng db search "type system" --profile local-dev
bgng db search "rust" --profile local-dev --mode hybrid --limit 20
bgng db changes --profile local-dev --cursor 42

Vector and hybrid search depend on upstream BeginningDB vector configuration.