ShellX CLI

ShellX CLI is a powerful command-line interface that combines advanced AI intelligence with Android device automation capabilities. It provides seamless shell command execution, UI automation, and AI-powered assistance for Android development and testing.

✨ Features

🤖 AI-Powered Assistance

• AI Integration: Direct access to advanced AI models through an intuitive CLI
• Code Generation: Generate code, scripts, and automation workflows
• Smart Debugging: AI-assisted troubleshooting and error analysis
• Natural Language Commands: Execute complex tasks using natural language

📱 Android Device Control

• Shell Command Execution: Run shell commands on Android devices with real-time output
• UI Automation: Advanced element finding with retry logic and multiple strategies
• Screen Operations: Screenshots, screen info, and visual change detection
• Device Management: Comprehensive device information and control

🔧 Developer Experience

• Zero-Configuration Setup: Automatic authentication and service connection
• Intelligent Fallback: Seamless switching between cloud and local services
• Robust Error Handling: Comprehensive error recovery and diagnostics
• Extensible Architecture: Plugin system for custom tools and integrations

🏗️ Monorepo Structure

• Modular Design: Organized into focused packages for different capabilities
• Cross-Platform: Supports Windows, macOS, and Linux
• Container Ready: Docker support for sandboxed environments

🚀 Quick Start

Prerequisites

• Node.js 20.0.0 or higher
• Android device or emulator (for Android features)
• ShellX.ai account (for cloud features)

Installation

From NPM (Recommended)

npm install -g shellx-cli

From Source

git clone https://github.com/10cl/shellx.git
cd shellx-cli
npm install
npm run build
npm run bundle

Basic Setup

1. Set Environment Variables:

# For ShellX Android automation
export SHELLX_AUTH_KEY="your-shellx-auth-key"

2. Initialize the CLI:

shellx --help

Development Workflow

# Start development server
npm run start

# Run tests
npm run test

# Build for production
npm run build

# Run linting
npm run lint

🏗️ Project Structure

This is a monorepo containing several key packages:

shellx-cli/
├── packages/
│   ├── cli/                 # Main CLI interface
│   ├── core/                # Core functionality
│   ├── shellx-ai/           # Android automation library
│   ├── a2a-server/          # Agent-to-Agent server
│   ├── phone-agent/         # Phone automation agent
│   ├── shellx-binary/       # Binary assets management
│   └── vscode-ide-companion/ # VS Code integration
├── bundle/                  # Compiled CLI bundle
├── scripts/                 # Build and development scripts
└── docs/                    # Documentation

Key Packages

• shellx-ai: Android device automation and UI control library
• phone-agent: Specialized agent for phone automation tasks

🤝 Contributing

Development Setup

1. Clone the repository:

git clone https://github.com/10cl/shellx.git
cd shellx-cli

2. Install dependencies:

npm install

3. Set up development environment:

npm run build:packages

4. Run in development mode:

npm run start

Pull Request Process

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Run tests and quality checks
5. Submit a pull request

📋 Roadmap

Key focus areas:

• Enhanced AI model integration
• Improved Android automation capabilities
• Better developer tooling
• Expanded platform support
• Performance optimizations

🐛 Troubleshooting

Common Issues

Connection Problems

# Check device connection
adb devices

Build Issues

# Clean and rebuild
npm run clean
npm install
npm run build

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

🆘 Support

• 📚 Documentation
• 🐛 GitHub Issues
• 📧 Email Support

🙏 Acknowledgments

• ShellX.ai: For Android automation infrastructure
• Open Source Community: For contributions and feedback

Made with ❤️ by the ShellX team