Skip to content

JetBrains/databao-cli

Repository files navigation

official project PyPI version License

Databao CLI

A command-line interface tool for working with Databao Agent and Databao Context Engine

WebsiteQuickstartDocsDiscord


Installation

Databao CLI is available on PyPI and can be installed with uv, pip, or another package manager.

Using uv

uv add databao

Using pip

pip install databao

Quickstart

  1. Create a project directory and navigate to it:

    mkdir databao-project && cd databao-project

    [!TIP] Databao is not terminal-only. If you prefer the web interface, run databao app in your project directory.

  2. Initialize the project:

    databao init
  3. When prompted, agree to configure a domain – a dedicated space where data context, context, and agent chats live.

    Then follow the prompts to add one or several data sources.

  4. Build context:

    databao build
  5. Pass your API key as an environment variable:

    # OpenAI or OpenAI-compatible APIs
    export OPENAI_API_KEY=<your-key>
    
    # Anthropic Claude
    export ANTHROPIC_API_KEY=<your-key>
  6. Run the Databao Agent:

    databao ask
  7. Ask questions about your data:

    # Example questions:
    What is our refund rate by month?
    What is our 90-day repeat purchase rate
    

For more details about commands, supported data sources, and configuration options, visit the docs.

Contributing

We love contributions! Here’s how you can help:

  • Star this repo — it helps others find us!
  • 🐛 Found a bug? Open an issue
  • 💡 Have an idea? We’re all ears — create a feature request
  • 👍 Upvote issues you care about — helps us prioritize
  • 🔧 Submit a PR
  • 📝 Improve docs — typos, examples, tutorials — everything helps!

New to open source? No worries! We’re friendly and happy to help you get started.

License

Apache 2.0 — use it however you want.

See the LICENSE file for details.


Like Databao? Give us a ⭐! It will help to distribute the technology.

WebsiteDocsDiscord