Skip to main content

BAUCLI — AI-powered database documentation CLI for BAU

Project description

BAUCLI

AI-powered database documentation CLI for BAU — runs on the developer's machine.

BAUCLI connects to your databases, extracts PL/SQL objects and table metadata, and syncs them with the BAU Server for automatic AI documentation.

Quick Start

# Install
pip install baucli

# or with all database drivers
pip install baucli[all]

# Activate license
baucli init --license BAU-XXXX-XXXX-XXXX-XXXX

# Add a database
baucli connect --name dev_oracle --engine oracle \
  --host localhost --port 1521 --service XEPDB1 --user DEMO_HR \
  --schemas DEMO_HR

# Sync objects to BAU Server
baucli sync

# Download AI context for your IDE
baucli context

Commands

Command Description
baucli init --license <key> Activate license, receive API key
baucli connect --name <alias> ... Add and test a database connection
baucli sync [--db name | --all] Sync objects to BAU Server
baucli context [--db name] Download AI context (CLAUDE.md)
baucli status Show config, quota, pending deploys
baucli deploy list List pending deploys
baucli deploy approve <id> Approve a deploy
baucli deploy apply <id> Download and apply deploy script
baucli db list List configured databases
baucli db remove <name> Remove a database
baucli db default <name> Set default database

Multi-Database Support

Configure multiple databases in ~/.baucli/config.json:

# Add Oracle dev
baucli connect --name dev_oracle --engine oracle --host localhost --port 1521 --service XEPDB1 --user HR

# Add PostgreSQL staging
baucli connect --name staging_pg --engine postgresql --host pg-staging --port 5432 --database erp --user app_user

# Add SQL Server production
baucli connect --name prod_mssql --engine mssql --host sql-prod --port 1433 --database erp --user bau_reader

# Sync specific database
baucli sync --db staging_pg

# Sync all
baucli sync --all

# Set default
baucli db default dev_oracle

Supported Databases

Engine Driver Install
Oracle 19c+ oracledb (thin mode) pip install baucli (included)
PostgreSQL 14+ psycopg pip install baucli (included)
SQL Server 2019+ python-tds pip install baucli (included)
MySQL 8.0+ mysql-connector pip install baucli (included)

Configuration

Config file: ~/.baucli/config.json

{
  "license_key": "BAU-XXXX-XXXX-XXXX-XXXX",
  "api_url": "https://begbrokerdev.begcloud.com/ords/bauctx/api/v1",
  "api_key": "bau_cli_xxxx",
  "tenant_code": "ACME_CORP",
  "default_db": "dev_oracle",
  "databases": {
    "dev_oracle": {
      "engine": "oracle",
      "host": "localhost",
      "port": 1521,
      "service": "XEPDB1",
      "user": "DEMO_HR",
      "schemas": ["DEMO_HR"]
    },
    "staging_pg": {
      "engine": "postgresql",
      "host": "pg-staging.internal",
      "port": 5432,
      "database": "erp_hml",
      "user": "app_user",
      "schemas": ["public", "hr"]
    }
  },
  "sync_interval_min": 30,
  "context_output": "CLAUDE.md"
}

Passwords are stored separately in ~/.baucli/.credentials (restricted permissions).

Override config dir with BAUCLI_HOME=~/.baucli-tenant2 to keep multiple isolated profiles on the same machine.

Security

  • Database credentials never leave the developer's machine
  • Only extracted metadata and source code are sent to BAU Server via HTTPS
  • API key uses SHA256 hash — plain token shown once at baucli init
  • Passwords stored in ~/.baucli/.credentials with mode 600 (or OS keychain when available)
  • BAU Server never executes DDL on your database

Requirements

  • Python 3.9+
  • Network access to BAU Server (HTTPS)
  • Database access (read-only on DBA_SOURCE, DBA_TABLES, etc.)

License

Proprietary — BEG Support © 2025-2026 www.begcloud.com

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

baucli-1.0.2.tar.gz (214.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

baucli-1.0.2-py3-none-any.whl (224.0 kB view details)

Uploaded Python 3

File details

Details for the file baucli-1.0.2.tar.gz.

File metadata

  • Download URL: baucli-1.0.2.tar.gz
  • Upload date:
  • Size: 214.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for baucli-1.0.2.tar.gz
Algorithm Hash digest
SHA256 94f19bd2dc030d2ce9f95d1aaef28efe6294c9f59ba1605528d70f244de3ed4c
MD5 d1633eee88a841a0734256663777c768
BLAKE2b-256 fc495dfebaf90c7af18ea092f232c71f862d1889aae985f8b0aee7d608baeb3e

See more details on using hashes here.

File details

Details for the file baucli-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: baucli-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 224.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for baucli-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8cfc81703e0540f1baacc919fa71ec7c48858edc35c21769d63e2ddc68726359
MD5 ccfe83ddccd5c6b575707aa3539b6757
BLAKE2b-256 a7dd062c7b03619ae46493d2e858f290055171232c375f4b8df9c7df2bb740fb

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page