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.34.tar.gz (454.5 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.34-py3-none-any.whl (469.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: baucli-1.0.34.tar.gz
  • Upload date:
  • Size: 454.5 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.34.tar.gz
Algorithm Hash digest
SHA256 46311dc7949e87e42ac69fb836d5c05ac3ea9d5aaa607a65ad1d7c15a46ee596
MD5 e7e990fb0efa384ec6ef720873ec5e83
BLAKE2b-256 598fd86a0a6d62ec3002b28d0d4aef5e2ac70c03e9fd4a22752ca7c4a75bf4ca

See more details on using hashes here.

File details

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

File metadata

  • Download URL: baucli-1.0.34-py3-none-any.whl
  • Upload date:
  • Size: 469.3 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.34-py3-none-any.whl
Algorithm Hash digest
SHA256 177e7c18fdc1636e697b50b2248594fb83fcb7bd493e6c15191d33941f85a403
MD5 4d0935423333a9bb6a6ca673b7dc6c24
BLAKE2b-256 819620e89a4a9109cf2f66ca73518a6f298dfc5da9e97a446c76587a9c5ad0cd

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