dbagent-cli 0.1.1__tar.gz → 0.1.3__tar.gz

{dbagent_cli-0.1.1 → dbagent_cli-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbagent-cli
-Version: 0.1.1
+Version: 0.1.3
 Summary: Universal Database Introspection and Script Generation AI Agent (CLI)
 Author: Santhosh Gupta
 Requires-Python: >=3.9

{dbagent_cli-0.1.1 → dbagent_cli-0.1.3}/dbagent/__init__.py

@@ -2,5 +2,5 @@
 DB-Agent: Universal Database Introspection and Script Generation AI Agent (CLI).
 """
 
-__version__ = "0.1.1"
+__version__ = "0.1.3"
 __author__ = "Santhosh Gupta"

{dbagent_cli-0.1.1 → dbagent_cli-0.1.3}/dbagent/cli.py

@@ -14,7 +14,7 @@ from rich.table import Table
 from prompt_toolkit import PromptSession
 from prompt_toolkit.history import FileHistory
 
-from dbagent import __version__
+from dbagent import __version__, __author__
 from dbagent.config import ConfigManager
 from dbagent.connectors.factory import create_connector
 from dbagent.schema.formatter import SchemaFormatter
@@ -145,6 +145,86 @@ def _display_pipeline_result(result: PipelineResult, show_sql: bool = True) -> N
         print_code(result.sql, "sql", "Generated SQL")
 
 
+def display_command_guide() -> None:
+    """Display comprehensive command reference table."""
+    print_banner()
+    console.print("[bold cyan]DB-Agent Command Reference & Guide[/bold cyan]\n")
+
+    # Table 1: Core Query & Chat
+    t1 = Table(title="[bold green]1. Core Query & Interactive Commands[/bold green]", show_header=True, header_style="bold cyan", border_style="dim")
+    t1.add_column("Command", style="bold white", width=18)
+    t1.add_column("How to Use (Example)", style="cyan", width=42)
+    t1.add_column("When to Use", style="dim")
+    t1.add_row(
+        "ask",
+        'db-agent ask "list top 10 users" --db devdb',
+        "Ask in natural language -> generates SQL & immediately shows results.",
+    )
+    t1.add_row(
+        "chat",
+        "db-agent chat --db devdb",
+        "Interactive multi-turn CLI session. Auto-executes reads, remembers schema.",
+    )
+    t1.add_row(
+        "run",
+        'db-agent run "SELECT * FROM users" --db devdb',
+        "Directly execute raw SQL queries on the database with Rich table output.",
+    )
+    console.print(t1)
+    console.print("")
+
+    # Table 2: Database Management
+    t2 = Table(title="[bold yellow]2. Database & Schema Commands[/bold yellow]", show_header=True, header_style="bold cyan", border_style="dim")
+    t2.add_column("Command", style="bold white", width=18)
+    t2.add_column("How to Use (Example)", style="cyan", width=42)
+    t2.add_column("When to Use", style="dim")
+    t2.add_row(
+        "connect",
+        "db-agent connect <url> --alias prod_db",
+        "Test credentials and save connection URL under a friendly alias name (< 0.1s).",
+    )
+    t2.add_row(
+        "scan",
+        "db-agent scan --db prod_db --export db.md",
+        "Deeply inspect tables, columns, relations, indexes, and export to Markdown/JSON.",
+    )
+    t2.add_row(
+        "profiles",
+        "db-agent profiles",
+        "List all saved database aliases and their connection URLs.",
+    )
+    console.print(t2)
+    console.print("")
+
+    # Table 3: AI & Code Generation
+    t3 = Table(title="[bold magenta]3. Standalone AI & Generator Commands[/bold magenta]", show_header=True, header_style="bold cyan", border_style="dim")
+    t3.add_column("Command", style="bold white", width=18)
+    t3.add_column("How to Use (Example)", style="cyan", width=42)
+    t3.add_column("When to Use", style="dim")
+    t3.add_row(
+        "setup",
+        "db-agent setup",
+        "1-Click offline AI setup. Downloads Ollama & coding model for 100% standalone use.",
+    )
+    t3.add_row(
+        "generate",
+        'db-agent generate "create ETL" --db devdb -o etl.py',
+        "Generate dialect SQL, Alembic migrations, Python ETL, or APIs to files.",
+    )
+    t3.add_row(
+        "config",
+        "db-agent config",
+        "Interactive wizard to set default AI provider (Ollama, Gemini, Groq, OpenRouter).",
+    )
+    t3.add_row(
+        "models",
+        "db-agent models",
+        "Check status (Online/Offline) of local Ollama models and cloud AI providers.",
+    )
+    console.print(t3)
+    console.print("\n[dim]Run [bold]db-agent <command> --help[/bold] for detailed options on any command.[/dim]\n")
+
+
 # ---------------------------------------------------------------------------
 # CLI Commands
 # ---------------------------------------------------------------------------
@@ -156,11 +236,16 @@ def main(
 ):
     """DB-Agent CLI entry point."""
     if version:
-        console.print(f"DB-Agent version [bold cyan]{__version__}[/bold cyan]")
+        console.print(f"DB-Agent version [bold cyan]{__version__}[/bold cyan] by [bold]{__author__}[/bold]")
         raise typer.Exit()
     if ctx.invoked_subcommand is None:
-        print_banner()
-        console.print("[dim]Run [bold]db-agent --help[/bold] to see all available commands, or [bold]db-agent chat[/bold] to start interactive mode.[/dim]\n")
+        display_command_guide()
+
+
+@app.command(name="guide")
+def guide_command():
+    """Display comprehensive command reference, usage examples, and when to use each command."""
+    display_command_guide()
 
 
 # ---- ask (flagship seamless command) ----
@@ -683,34 +768,52 @@ def models_command():
 @app.command(name="setup")
 def setup_command(
     model: str = typer.Option("qwen2.5-coder:1.5b", "--model", "-m", help="Ollama model to install"),
+    yes: bool = typer.Option(False, "--yes", "-y", help="Skip confirmation prompt and install local Ollama automatically"),
 ):
-    """Automatically download, install, start, and configure Ollama for 100% standalone offline AI."""
+    """Setup wizard: Choose to install standalone local AI (Ollama) or configure cloud AI providers."""
     print_banner()
-    console.print("[bold cyan]DB-Agent Standalone AI Engine Setup[/bold cyan]\n")
-    console.print("[dim]This will ensure Ollama is installed, running, and has a local code model ready.[/dim]\n")
+    console.print("[bold cyan]DB-Agent AI Engine Setup Wizard[/bold cyan]\n")
 
-    from dbagent.llm.auto_setup import ensure_ollama_ready
+    install_local = yes
+    if not yes:
+        console.print("[bold white]DB-Agent supports two ways to run AI:[/bold white]")
+        console.print("  1. [bold green]Local Offline AI (Ollama)[/bold green]: 100% private, zero-cost, runs on your machine without API keys.")
+        console.print("  2. [bold cyan]Free Cloud AI (Gemini / Groq)[/bold cyan]: Lightweight, runs in the cloud via free API keys.\n")
 
-    def _log(msg, level="info"):
-        if level == "success":
-            print_success(msg)
-        elif level == "warning":
-            print_warning(msg)
-        elif level == "error":
-            print_error(msg)
-        elif level == "progress":
-            console.print(f"[dim]{msg}[/dim]")
-        else:
-            print_info(msg)
+        install_local = Confirm.ask(
+            "Would you like to install & configure local offline AI (Ollama + Coding Model)?",
+            default=True,
+        )
+
+    if install_local:
+        console.print("\n[dim]Setting up local offline AI engine...[/dim]\n")
+        from dbagent.llm.auto_setup import ensure_ollama_ready
 
-    success, message = ensure_ollama_ready(model=model, print_fn=_log)
-    if success:
-        config_mgr.set_setting("default_provider", "ollama")
-        print_success(message)
-        console.print("\n[bold green]You're all set![/bold green] DB-Agent is now 100% standalone and ready to run queries.\n")
+        def _log(msg, level="info"):
+            if level == "success":
+                print_success(msg)
+            elif level == "warning":
+                print_warning(msg)
+            elif level == "error":
+                print_error(msg)
+            elif level == "progress":
+                console.print(f"[dim]{msg}[/dim]")
+            else:
+                print_info(msg)
+
+        success, message = ensure_ollama_ready(model=model, print_fn=_log)
+        if success:
+            config_mgr.set_setting("default_provider", "ollama")
+            print_success(message)
+            console.print("\n[bold green]You're all set![/bold green] DB-Agent is now configured with local offline AI.\n")
+        else:
+            print_error(message)
+            raise typer.Exit(1)
     else:
-        print_error(message)
-        raise typer.Exit(1)
+        print_info("Skipped local Ollama installation.")
+        console.print("\n[bold white]Next Steps for Cloud AI:[/bold white]")
+        console.print("  * Run [bold cyan]db-agent config[/bold cyan] anytime to configure free Google Gemini or Groq API keys.")
+        console.print("  * Or connect directly to your database with [bold cyan]db-agent connect <url> --alias <name>[/bold cyan]\n")
 
 
 if __name__ == "__main__":

{dbagent_cli-0.1.1 → dbagent_cli-0.1.3}/dbagent_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbagent-cli
-Version: 0.1.1
+Version: 0.1.3
 Summary: Universal Database Introspection and Script Generation AI Agent (CLI)
 Author: Santhosh Gupta
 Requires-Python: >=3.9

{dbagent_cli-0.1.1 → dbagent_cli-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dbagent-cli"
-version = "0.1.1"
+version = "0.1.3"
 description = "Universal Database Introspection and Script Generation AI Agent (CLI)"
 readme = "README.md"
 requires-python = ">=3.9"