bydbctl/

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/apache/skywalking-banyandb

Links

Open Source Insights

README ¶

BanyanDB Command Line Tool

bydbctl is a command line tool to interact with BanyanD.

BYDBQL Agent TUI

bydbctl agent uses either Codex app-server or a directly supervised Claude CLI for multi-turn schema and query conversations in a persistent two-pane terminal workspace. bydbctl owns the controlled tool bridge, deterministically renders BYDBQL, and requires approval before full execution unless the user explicitly trusts the session. See the BYDBQL Agent TUI guide.

Build

# If you haven't generated the API code yet
make -C ../api generate

make build

Directories ¶

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

Path	Synopsis
cmd
cli command Package main provides main entry for the command-line toolkit, i.e.	Package main provides main entry for the command-line toolkit, i.e.
internal
cmd Package cmd is an internal package defining cli commands for bydbctl.	Package cmd is an internal package defining cli commands for bydbctl.
tui/agent Package agent defines provider-neutral contracts for coding agent integration.	Package agent defines provider-neutral contracts for coding agent integration.
tui/agent/claude Package claude provides a fail-closed Claude CLI gateway for bydbctl.	Package claude provides a fail-closed Claude CLI gateway for bydbctl.
tui/agent/codex Package codex provides a fail-closed Codex app-server gateway for bydbctl.	Package codex provides a fail-closed Codex app-server gateway for bydbctl.
tui/agent/fake Package fake provides a deterministic agent implementation for TUI tests and demos.	Package fake provides a deterministic agent implementation for TUI tests and demos.
tui/agent/prompt Package prompt builds BYDBQL generation prompts for agent adapters.	Package prompt builds BYDBQL generation prompts for agent adapters.
tui/app Package app implements the Bubble Tea user interface for bydbctl agent.	Package app implements the Bubble Tea user interface for bydbctl agent.
tui/applog Package applog writes detailed bydbctl agent TUI diagnostics to a session log file.	Package applog writes detailed bydbctl agent TUI diagnostics to a session log file.
tui/bridge Package bridge provides the private, bydbctl-owned tool set exposed to agents.	Package bridge provides the private, bydbctl-owned tool set exposed to agents.
tui/bydbql Package bydbql validates BYDBQL candidates for the bydbctl agent TUI workflow.	Package bydbql validates BYDBQL candidates for the bydbctl agent TUI workflow.
tui/catalog Package catalog provides deterministic BanyanDB resource ranking and matching.	Package catalog provides deterministic BanyanDB resource ranking and matching.
tui/execution Package execution owns the shared validation and execution lifecycle for BYDBQL candidates.	Package execution owns the shared validation and execution lifecycle for BYDBQL candidates.
tui/planner Package planner validates structured query plans and deterministically renders BYDBQL.	Package planner validates structured query plans and deterministically renders BYDBQL.
tui/session Package session defines the durable state shared by the bydbctl agent TUI workflow and agent adapters.	Package session defines the durable state shared by the bydbctl agent TUI workflow and agent adapters.
tui/tools Package tools defines the bydbctl-owned tool boundary used by the TUI workflow.	Package tools defines the bydbctl-owned tool boundary used by the TUI workflow.
tui/tuirun Package tuirun launches the agent TUI's background goroutines under panic recovery.	Package tuirun launches the agent TUI's background goroutines under panic recovery.
tui/tuitext Package tuitext holds the string helpers shared across the agent TUI packages.	Package tuitext holds the string helpers shared across the agent TUI packages.
tui/workflow Package workflow owns the deterministic BYDBQL assistant state machine.	Package workflow owns the deterministic BYDBQL assistant state machine.
pkg
file Package file provides utils to handle files.	Package file provides utils to handle files.