aitbc1
394ecb49b9
MERGE OPERATIONS: - Merged /opt/aitbc/cli/docs into /opt/aitbc/docs/cli - Eliminated duplicate CLI documentation locations - Created single source of truth for CLI docs ORGANIZATION IMPROVEMENTS: - Created structured subdirectories: • implementation/ - Core implementation summaries • analysis/ - Analysis reports and integration summaries • guides/ - Installation and setup guides • legacy/ - Historical documentation (archived) - Updated main README.md with: • New consolidated structure overview • Updated installation instructions for flat CLI structure • Recent CLI design principles changes • Proper navigation to subdirectories - Created legacy/README.md with: • Clear deprecation notice • File categorization • Purge candidates identification • Migration notes from old to new structure FILE MOVES: - 15 implementation summaries → implementation/ - 5 analysis reports → analysis/ - 3 setup guides → guides/ - 19 legacy documented files → legacy/ - 1 demonstration file → root (active reference) PROJECT DOCUMENTATION UPDATES: - Updated /docs/beginner/02_project/1_files.md - Reflected flattened CLI structure (cli/commands/ vs cli/aitbc_cli/commands/) - Added docs/cli/ as consolidated documentation location - Updated Python version requirement to 3.13.5 only BENEFITS: - Single location for all CLI documentation - Clear separation of current vs legacy information - Better organization and discoverability - Easier maintenance and updates - Proper archival of historical documentation STATUS: ✅ Consolidation complete ✅ Legacy properly archived ✅ Structure organized ✅ Documentation updated
108 lines
3.2 KiB
Markdown
108 lines
3.2 KiB
Markdown
# AITBC CLI Documentation
|
|
|
|
**Updated**: 2026-03-26
|
|
**Status**: Active Development - CLI Design Principles Applied
|
|
**Structure**: Consolidated and Organized
|
|
|
|
## 📁 Documentation Structure
|
|
|
|
### 🚀 [Main CLI Guide](README.md)
|
|
- Installation and setup
|
|
- Quick start guide
|
|
- Command reference
|
|
- Configuration
|
|
|
|
### 📚 [Implementation Documentation](implementation/)
|
|
- [Agent Communication Implementation](implementation/AGENT_COMMUNICATION_IMPLEMENTATION_SUMMARY.md)
|
|
- [Analytics Implementation](implementation/ANALYTICS_IMPLEMENTATION_SUMMARY.md)
|
|
- [Deployment Implementation](implementation/DEPLOYMENT_IMPLEMENTATION_SUMMARY.md)
|
|
- [Marketplace Implementation](implementation/MARKETPLACE_IMPLEMENTATION_SUMMARY.md)
|
|
- [Multi-Chain Implementation](implementation/MULTICHAIN_IMPLEMENTATION_SUMMARY.md)
|
|
|
|
### 📊 [Analysis & Reports](analysis/)
|
|
- [CLI Wallet Daemon Integration](analysis/CLI_WALLET_DAEMON_INTEGRATION_SUMMARY.md)
|
|
- [Implementation Complete Summary](analysis/IMPLEMENTATION_COMPLETE_SUMMARY.md)
|
|
- [Localhost Only Enforcement](analysis/LOCALHOST_ONLY_ENFORCEMENT_SUMMARY.md)
|
|
- [Node Integration](analysis/NODE_INTEGRATION_SUMMARY.md)
|
|
- [Wallet Chain Connection](analysis/WALLET_CHAIN_CONNECTION_SUMMARY.md)
|
|
|
|
### 🛠️ [Installation & Setup Guides](guides/)
|
|
- [Quick Install Guide](guides/QUICK_INSTALL_GUIDE.md)
|
|
- [Local Package README](guides/LOCAL_PACKAGE_README.md)
|
|
- [CLI Test Results](guides/CLI_TEST_RESULTS.md)
|
|
|
|
### 🗃️ [Legacy Documentation](legacy/)
|
|
Historical documentation from previous development phases. Retained for reference but may contain outdated information.
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### Installation
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://github.com/aitbc/aitbc.git
|
|
cd aitbc/cli
|
|
|
|
# Install in development mode (flat structure)
|
|
pip install -e .
|
|
|
|
# Or use the virtual environment
|
|
python3 -m venv venv
|
|
source venv/bin/activate
|
|
pip install -e .
|
|
```
|
|
|
|
### Basic Usage
|
|
|
|
```bash
|
|
# Check CLI is working
|
|
aitbc --help
|
|
|
|
# Set up API key
|
|
export AITBC_API_KEY=your_api_key_here
|
|
aitbc config set api_key your_api_key_here
|
|
|
|
# Check wallet balance
|
|
aitbc wallet balance
|
|
|
|
# Submit a job
|
|
aitbc client submit --prompt "Generate an image" --model llama2
|
|
|
|
# Check miner status
|
|
aitbc miner status
|
|
```
|
|
|
|
---
|
|
|
|
## 🎯 Recent Changes (2026-03-26)
|
|
|
|
### ✅ CLI Design Principles Applied
|
|
- **Removed embedded servers** - CLI now controls services instead of hosting them
|
|
- **Flattened directory structure** - Eliminated "box in a box" nesting
|
|
- **Simplified HTTP clients** - Replaced async pools with basic calls
|
|
- **Removed blocking loops** - Single status checks instead of infinite monitoring
|
|
- **No auto-opening browsers** - Provides URLs for user control
|
|
- **Removed system calls** - CLI provides instructions instead of executing
|
|
|
|
### 📁 Documentation Consolidation
|
|
- **Merged** `/cli/docs` into `/docs/cli` for single source of truth
|
|
- **Organized** into implementation, analysis, guides, and legacy sections
|
|
- **Updated** installation instructions for flat structure
|
|
- **Purged** duplicate and outdated documentation
|
|
|
|
---
|
|
|
|
## 🔗 Related Documentation
|
|
|
|
- [Main AITBC Documentation](../README.md)
|
|
- [Project File Structure](../1_project/1_files.md)
|
|
- [Development Roadmap](../1_project/2_roadmap.md)
|
|
|
|
---
|
|
|
|
*Last updated: 2026-03-26*
|
|
*CLI Version: 0.2.0*
|
|
*Python: 3.13.5+*
|