Databao docs

This page provides an overview of the Databao CLI commands and options.

Basic usage:

databao <command> [OPTIONS]

Global options

Flag	Description
`-p, --project-dir PATH`	Location of your Databao project. Default is the current working directory.

CLI commands

Command	Description	Example
`status`	Display project status and system-wide information.	`databao status`
`init`	Create a new Databao project.	`databao init`
`build`	Build context for all domain's data sources.
`ask`	Chat with the Databao agent.	`databao ask`
`app`	Open the Databao app in the browser.	`databao app`

`status`

Displays project status and system-wide information.

databao status [OPTIONS]

Create a new Databao project in the current directory or in the specified directory. It creates the project structure (.databao/domains/root, .databao/agents) and allows you to configure data sources interactively.

databao init [OPTIONS]

`build`

Build context for all domain's data sources. The output is saved in the domain's output directory.

databao build [OPTIONS]

Option	Description
`-d, --domain TEXT`	Databao domain name. Default is "root".

`ask`

Chat with the Databao agent.

databao ask [OPTIONS] [QUESTION]

Option	Description
`--one-shot`	Execute a single question and exit. Default is `false`. If not provided, inteactive mode is started.
`-m, --model TEXT`	LLM model in the `provider:name` format. Examples: `openai:gpt-4o`, `anthropic:claude-3-5-sonnet`.
`-t, --temperature FLOAT`	Temperature in the 0.0-1.0 range. Default is `0.0`.
`--show-thinking / --no-show-thinking`	Display reasoning/thinking output. Default is `true`.

Starts an interactive chat session with the Databao agent or executes a single query if --one-shot is provided.

Examples:

databao ask                                          # Interactive mode
databao ask --one-shot "What tables exist?"          # One-shot mode
databao ask --model anthropic:claude-3-5-sonnet      # Use custom model
databao ask --no-show-thinking                       # Hide reasoning

`app`

Launch Databao in the browser.

databao app [OPTIONS] [STREAMLIT_ARGS]...