oib/aitbc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README with comprehensive test results, CLI documentation, and enhanced feature descriptions

Browse Source 
- Update key capabilities to include GPU marketplace, payments, billing, and governance
- Expand CLI section from basic examples to 12 command groups with 90+ subcommands
- Add detailed test results table showing 208 passing tests across 6 test suites
- Update documentation links to reference new CLI reference and coordinator API docs
- Revise test commands to reflect actual test structure (
This commit is contained in:
oib
2026-02-12 20:58:21 +01:00
parent 5120861e17
commit 65b63de56f
47 changed files with 5622 additions and 1148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/cli-summary.md
View File

@@ -1,28 +1,29 @@
# AITBC CLI Enhancement Summary
## Overview
All CLI enhancement phases (0–5) are complete. The AITBC CLI provides a production-ready interface with 116/116 tests passing, 11 command groups, and 80+ subcommands.
All CLI enhancement phases (0–5) are complete. The AITBC CLI provides a production-ready interface with 141/141 tests passing, 12 command groups, and 90+ subcommands.
## Architecture
- **Package**: `cli/aitbc_cli/` with modular commands
- **Framework**: Click + Rich for output formatting
- **Testing**: pytest with Click CliRunner, 116/116 passing
- **Testing**: pytest with Click CliRunner, 141/141 passing
- **CI/CD**: `.github/workflows/cli-tests.yml` (Python 3.10/3.11/3.12)
## Command Groups
| Group | Subcommands |
|-------|-------------|
| **client** | submit, status, blocks, receipts, cancel, history, batch-submit, template |
| **client** | submit, status, blocks, receipts, cancel, history, batch-submit, template, create-payment, get-payment, release-payment, refund-payment |
| **miner** | register, poll, mine, heartbeat, status, earnings, update-capabilities, deregister, jobs, concurrent-mine |
| **wallet** | balance, earn, spend, send, history, address, stats, stake, unstake, staking-info, create, list, switch, delete, backup, restore, info, request-payment, multisig-create, multisig-propose, multisig-sign |
| **wallet** | balance, earn, spend, send, history, address, stats, stake, unstake, staking-info, create, list, switch, delete, backup, restore, info, request-payment, multisig-create, multisig-propose, multisig-sign, liquidity-stake, liquidity-unstake, rewards |
| **auth** | login, logout, token, status, refresh, keys (create/list/revoke), import-env |
| **blockchain** | blocks, block, transaction, status, sync-status, peers, info, supply, validators |
| **marketplace** | gpu (register/list/details/book/release), orders, pricing, reviews |
| **admin** | status, jobs, miners, analytics, logs, maintenance, audit-log |
| **config** | show, set, path, edit, reset, export, import, validate, environments, profiles, set-secret, get-secret |
| **monitor** | dashboard, metrics, alerts, history, webhooks |
| **monitor** | dashboard, metrics, alerts, history, webhooks, campaigns, campaign-stats |
| **simulate** | init, user (create/list/balance/fund), workflow, load-test, scenario, results, reset |
| **governance** | propose, vote, list, result |
| **plugin** | install, uninstall, list, toggle |
## Global Options