AIPass/src/aipass/cli/README.md

← Back to AIPass

CLI

Purpose: Display and output formatting service for all AIPass branches. Provides consistent terminal output — headers, success/error/warning messages, section breaks, and operation templates — so every branch looks the same without duplicating Rich formatting code. Module: aipass.cli Version: 2.1.0 Seedgo: 99% Tests: 127 passing (5 files) Last Updated: 2026-07-17

Quick Start

drone @cli                     # Show discovered modules
drone @cli display demo        # Run display function showcase
drone @cli templates demo      # Run operation template showcase
drone @cli --help              # Full usage guide

Usage

Import display functions from aipass.cli and call them to produce consistent Rich-formatted terminal output across all branches.

Display Functions

from aipass.cli import header, success, error, warning, section

header("Creating Branch", {"Name": "feature", "Type": "module"})
success("Files created", items=12, time="2.3s")
error("Path not found", suggestion="Check spelling")
warning("Config missing, using defaults")
section("Results")

Operation Templates

from aipass.cli.apps.modules import operation_start, operation_complete

operation_start("Processing", count=10)
# ... do work ...
operation_complete(created=5, skipped=3, failed=0, time="1.2s")

Fatal (exit on error)

from aipass.cli.apps.modules import fatal

fatal("Config file missing", suggestion="Run aipass init first")
# Prints error message + suggestion, then calls sys.exit(1)

Direct Console Access

from aipass.cli import console

console.print("[bold cyan]Custom Rich output[/bold cyan]")

Public API

Exported from apps/modules/__init__.py (10 symbols):

Function	Signature	Purpose
console	Rich Console instance	Standard output console
err_console	Rich Console instance	Stderr console
header()	header(title, details=None)	Bordered section header with optional key-value pairs
success()	success(message, **kwargs)	Green checkmark message with metadata
error()	error(message, suggestion=None)	Red error with optional suggestion
warning()	warning(message, details=None)	Yellow warning with optional details
fatal()	fatal(message, suggestion=None)	Error + sys.exit(1) for unrecoverable failures
section()	section(title)	Visual section separator with title
operation_start()	operation_start(operation, **details)	Standard operation begin header
operation_complete()	operation_complete(**summary)	Completion summary with optional timing

Import paths:

from aipass.cli import console, header, success, error, warning, section  # Top-level (6 symbols)
from aipass.cli.apps.modules import header, fatal, operation_start        # Full set (10 symbols)
from aipass.cli.apps.modules.display import header                        # Direct module

Commands

drone @cli --help              # Full help + architecture overview
drone @cli --version           # v2.1.0
drone @cli                     # Module discovery (introspection)
drone @cli display             # Display module info
drone @cli display demo        # Run display function showcase
drone @cli templates           # Templates module info
drone @cli templates demo      # Run templates function showcase
python -m aipass.cli --help    # Same help (no drone required)

Architecture

cli/
├── __init__.py                 # Top-level exports (6 symbols) + cli_entry()
├── __main__.py                 # python -m aipass.cli entry
├── apps/
│   ├── cli.py                  # Entry point (main, discover_modules, route_command)
│   ├── modules/                # PUBLIC — import from here
│   │   ├── __init__.py         # Re-exports all 10 display + template symbols
│   │   ├── display.py          # header, success, error, warning, fatal, section
│   │   └── templates.py        # operation_start, operation_complete
│   ├── handlers/               # PRIVATE — internal implementation
│   │   ├── json/
│   │   │   └── json_handler.py # JSON lifecycle (CRUD, validation, rotation)
│   │   └── templates/          # Scaffold placeholder
│   ├── integrations/           # Scaffold placeholder
│   └── plugins/                # Required by spawn builder template
├── tests/                      # 127 tests across 5 files
│   ├── test_display.py         # 45 tests — display functions + routing + triggers
│   ├── test_json_handler.py    # 39 tests — CRUD, validation, rotation
│   ├── test_templates.py       # 28 tests — operation templates + routing
│   ├── test_handler_guard.py   # 8 tests — cross-branch import guard
│   └── test_integration.py     # 7 tests — main() flow, entry points
├── cli_json/                   # Auto-created JSON (config, data, log)
├── logs/                       # Branch-level logs
└── .archive/                   # Archived stubs (extensions/, json_templates/, drone_adapter)

Two-tier design:

• apps/modules/ — Public API. Import from here.
• apps/handlers/ — Internal implementation. Don't import directly.

JSON Handler

Manages the three-file JSON pattern (config, data, log) for any module:

from aipass.cli.apps.handlers.json import json_handler

json_handler.log_operation("files_created", {"count": 12})
data = json_handler.load_json("cli", "config")
json_handler.save_json("cli", "data", {"key": "value"})
json_handler.ensure_module_jsons("cli")  # Create all 3 if missing

Integration Points

Depends On

• rich — Terminal formatting (Table, Panel, Text, Console)
• aipass.prax — Logging (imported in cli.py only, not in modules/)
• Python stdlib (sys, importlib, pathlib, json)

Cannot Import (in modules/)

• aipass.prax — Circular dependency (prax depends on cli). Bypassed in .seedgo/bypass.json.

Provides To

• All branches — Display formatting (header, success, error, warning, fatal, section)
• All branches — Operation templates (operation_start, operation_complete)
• All branches — Rich console access

Entry Points

Entry	Command	How
drone	drone @cli [command]	Routes to apps/cli.py:main()
Module	python -m aipass.cli [args]	__main__.py calls main()
console_scripts	aipass on PATH	cli_entry() in __init__.py

---

Last Updated: 2026-05-16

---

← Back to AIPass