shellx-cli 0.0.12 → 0.0.15

package/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-  Copyright 2025 Google LLC
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -199,4 +199,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

package/README.md

@@ -1,310 +1,188 @@
-# Gemini CLI
+# ShellX CLI
 
-[![Gemini CLI CI](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/google-gemini/gemini-cli/actions/workflows/ci.yml)
-[![Version](https://img.shields.io/npm/v/@google/gemini-cli)](https://www.npmjs.com/package/@google/gemini-cli)
-[![License](https://img.shields.io/github/license/google-gemini/gemini-cli)](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org/)
 
-![Gemini CLI Screenshot](./docs/assets/gemini-screenshot.png)
+**ShellX CLI** is a powerful command-line interface that combines the intelligence of Google's Gemini AI with advanced Android device automation capabilities. It provides seamless shell command execution, UI automation, and AI-powered assistance for Android development and testing.
 
-Gemini CLI is an open-source AI agent that brings the power of Gemini directly into your terminal. It provides lightweight access to Gemini, giving you the most direct path from your prompt to our model.
+## ✨ Features
 
-## 🚀 Why Gemini CLI?
+### 🤖 AI-Powered Assistance
+- **Gemini Integration**: Direct access to Google's Gemini 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
 
-- **🎯 Free tier**: 60 requests/min and 1,000 requests/day with personal Google account
-- **🧠 Powerful Gemini 2.5 Pro**: Access to 1M token context window
-- **🔧 Built-in tools**: Google Search grounding, file operations, shell commands, web fetching
-- **🔌 Extensible**: MCP (Model Context Protocol) support for custom integrations
-- **💻 Terminal-first**: Designed for developers who live in the command line
-- **🛡️ Open source**: Apache 2.0 licensed
+### 📱 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
 
-## 📦 Installation
+### 🔧 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
 
-### Quick Install
+### 🏗️ 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
 
-#### Run instantly with npx
+## 🚀 Quick Start
 
-```bash
-# Using npx (no installation required)
-npx https://github.com/google-gemini/gemini-cli
-```
+### Prerequisites
+- Node.js 20.0.0 or higher
+- Android device or emulator (for Android features)
+- ShellX.ai account (for cloud features)
 
-#### Install globally with npm
+### Installation
 
+#### From NPM (Recommended)
 ```bash
-npm install -g @google/gemini-cli
+npm install -g shellx-cli
 ```
 
-#### Install globally with Homebrew (macOS/Linux)
-
+#### From Source
 ```bash
-brew install gemini-cli
+git clone https://github.com/10cl/shellx-cli.git
+cd shellx-cli
+npm install
+npm run build
+npm run bundle
 ```
 
-#### System Requirements
-
-- Node.js version 20 or higher
-- macOS, Linux, or Windows
-
-## Release Cadence and Tags
-
-See [Releases](./docs/releases.md) for more details.
-
-### Preview
-
-New preview releases will be published each week at UTC 2359 on Tuesdays. These releases will not have been fully vetted and may contain regressions or other outstanding issues. Please help us test and install with `preview` tag.
+### Basic Setup
 
+1. **Set Environment Variables**:
 ```bash
-npm install -g @google/gemini-cli@preview
+# For ShellX Android automation
+export SHELLX_AUTH_KEY="your-shellx-auth-key"
 ```
 
-### Stable
-
-- New stable releases will be published each week at UTC 2000 on Tuesdays, this will be the full promotion of last week's `preview` release + any bug fixes and validations. Use `latest` tag.
-
+2. **Initialize the CLI**:
 ```bash
-npm install -g @google/gemini-cli@latest
+shellx --help
 ```
 
-### Nightly
-
-- New releases will be published each week at UTC 0000 each day, This will be all changes from the main branch as represented at time of release. It should be assumed there are pending validations and issues. Use `nightly` tag.
+### Development Workflow
 
 ```bash
-npm install -g @google/gemini-cli@nightly
-```
-
-## 📋 Key Features
-
-### Code Understanding & Generation
-
-- Query and edit large codebases
-- Generate new apps from PDFs, images, or sketches using multimodal capabilities
-- Debug issues and troubleshoot with natural language
-
-### Automation & Integration
-
-- Automate operational tasks like querying pull requests or handling complex rebases
-- Use MCP servers to connect new capabilities, including [media generation with Imagen, Veo or Lyria](https://github.com/GoogleCloudPlatform/vertex-ai-creative-studio/tree/main/experiments/mcp-genmedia)
-- Run non-interactively in scripts for workflow automation
+# Start development server
+npm run start
 
-### Advanced Capabilities
+# Run tests
+npm run test
 
-- Ground your queries with built-in [Google Search](https://ai.google.dev/gemini-api/docs/grounding) for real-time information
-- Conversation checkpointing to save and resume complex sessions
-- Custom context files (GEMINI.md) to tailor behavior for your projects
+# Build for production
+npm run build
 
-### GitHub Integration
-
-Integrate Gemini CLI directly into your GitHub workflows with [**Gemini CLI GitHub Action**](https://github.com/google-github-actions/run-gemini-cli):
-
-- **Pull Request Reviews**: Automated code review with contextual feedback and suggestions
-- **Issue Triage**: Automated labeling and prioritization of GitHub issues based on content analysis
-- **On-demand Assistance**: Mention `@gemini-cli` in issues and pull requests for help with debugging, explanations, or task delegation
-- **Custom Workflows**: Build automated, scheduled and on-demand workflows tailored to your team's needs
-
-## 🔐 Authentication Options
-
-Choose the authentication method that best fits your needs:
-
-### Option 1: OAuth login (Using your Google Account)
-
-**✨ Best for:** Individual developers as well as anyone who has a Gemini Code Assist License. (see [quota limits and terms of service](https://cloud.google.com/gemini/docs/quotas) for details)
-
-**Benefits:**
+# Run linting
+npm run lint
+```
 
-- **Free tier**: 60 requests/min and 1,000 requests/day
-- **Gemini 2.5 Pro** with 1M token context window
-- **No API key management** - just sign in with your Google account
-- **Automatic updates** to latest models
+## 🏗️ Project Structure
 
-#### Start Gemini CLI, then choose OAuth and follow the browser authentication flow when prompted
+This is a monorepo containing several key packages:
 
-```bash
-gemini
 ```
-
-#### If you are using a paid Code Assist License from your organization, remember to set the Google Cloud Project
-
-```bash
-# Set your Google Cloud Project
-export GOOGLE_CLOUD_PROJECT="YOUR_PROJECT_NAME"
-gemini
+shellx-cli/
+├── packages/
+│   ├── cli/                 # Main CLI interface (@google/gemini-cli)
+│   ├── core/                # Core functionality (@google/gemini-cli-core)
+│   ├── 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
 ```
 
-### Option 2: Gemini API Key
-
-**✨ Best for:** Developers who need specific model control or paid tier access
-
-**Benefits:**
-
-- **Free tier**: 100 requests/day with Gemini 2.5 Pro
-- **Model selection**: Choose specific Gemini models
-- **Usage-based billing**: Upgrade for higher limits when needed
-
-```bash
-# Get your key from https://aistudio.google.com/apikey
-export GEMINI_API_KEY="YOUR_API_KEY"
-gemini
-```
+### Key Packages
 
-### Option 3: Vertex AI
+- **shellx-ai**: Android device automation and UI control library
+- **phone-agent**: Specialized agent for phone automation tasks
 
-**✨ Best for:** Enterprise teams and production workloads
 
-**Benefits:**
+## 🤝 Contributing
 
-- **Enterprise features**: Advanced security and compliance
-- **Scalable**: Higher rate limits with billing account
-- **Integration**: Works with existing Google Cloud infrastructure
+### Development Setup
 
+1. **Clone the repository**:
 ```bash
-# Get your key from Google Cloud Console
-export GOOGLE_API_KEY="YOUR_API_KEY"
-export GOOGLE_GENAI_USE_VERTEXAI=true
-gemini
+git clone https://github.com/10cl/shellx-cli.git
+cd shellx-cli
 ```
 
-For Google Workspace accounts and other authentication methods, see the [authentication guide](./docs/cli/authentication.md).
-
-## 🚀 Getting Started
-
-### Basic Usage
-
-#### Start in current directory
-
+2. **Install dependencies**:
 ```bash
-gemini
+npm install
 ```
 
-#### Include multiple directories
-
+3. **Set up development environment**:
 ```bash
-gemini --include-directories ../lib,../docs
+npm run build:packages
 ```
 
-#### Use specific model
-
+4. **Run in development mode**:
 ```bash
-gemini -m gemini-2.5-flash
+npm run start
 ```
 
-#### Non-interactive mode for scripts
+### Pull Request Process
 
-```bash
-gemini -p "Explain the architecture of this codebase"
-```
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Run tests and quality checks
+5. Submit a pull request
 
-### Quick Examples
+## 📋 Roadmap
 
-#### Start a new project
+Key focus areas:
+- Enhanced AI model integration
+- Improved Android automation capabilities
+- Better developer tooling
+- Expanded platform support
+- Performance optimizations
 
-```bash
-cd new-project/
-gemini
-> Write me a Discord bot that answers questions using a FAQ.md file I will provide
-```
+## 🐛 Troubleshooting
 
-#### Analyze existing code
+### Common Issues
 
+**Connection Problems**
 ```bash
-git clone https://github.com/google-gemini/gemini-cli
-cd gemini-cli
-gemini
-> Give me a summary of all of the changes that went in yesterday
+# Check device connection
+adb devices
 ```
 
-## 📚 Documentation
-
-### Getting Started
-
-- [**Quickstart Guide**](./docs/cli/index.md) - Get up and running quickly
-- [**Authentication Setup**](./docs/cli/authentication.md) - Detailed auth configuration
-- [**Configuration Guide**](./docs/cli/configuration.md) - Settings and customization
-- [**Keyboard Shortcuts**](./docs/keyboard-shortcuts.md) - Productivity tips
-
-### Core Features
-
-- [**Commands Reference**](./docs/cli/commands.md) - All slash commands (`/help`, `/chat`, `/mcp`, etc.)
-- [**Checkpointing**](./docs/checkpointing.md) - Save and resume conversations
-- [**Memory Management**](./docs/tools/memory.md) - Using GEMINI.md context files
-- [**Token Caching**](./docs/cli/token-caching.md) - Optimize token usage
-
-### Tools & Extensions
-
-- [**Built-in Tools Overview**](./docs/tools/index.md)
-  - [File System Operations](./docs/tools/file-system.md)
-  - [Shell Commands](./docs/tools/shell.md)
-  - [Web Fetch & Search](./docs/tools/web-fetch.md)
-  - [Multi-file Operations](./docs/tools/multi-file.md)
-- [**MCP Server Integration**](./docs/tools/mcp-server.md) - Extend with custom tools
-- [**Custom Extensions**](./docs/extension.md) - Build your own commands
-
-### Advanced Topics
-
-- [**Architecture Overview**](./docs/architecture.md) - How Gemini CLI works
-- [**IDE Integration**](./docs/ide-integration.md) - VS Code companion
-- [**Sandboxing & Security**](./docs/sandbox.md) - Safe execution environments
-- [**Enterprise Deployment**](./docs/deployment.md) - Docker, system-wide config
-- [**Telemetry & Monitoring**](./docs/telemetry.md) - Usage tracking
-- [**Tools API Development**](./docs/core/tools-api.md) - Create custom tools
-
-### Configuration & Customization
-
-- [**Settings Reference**](./docs/cli/configuration.md) - All configuration options
-- [**Theme Customization**](./docs/cli/themes.md) - Visual customization
-- [**.gemini Directory**](./docs/gemini-ignore.md) - Project-specific settings
-- [**Environment Variables**](./docs/cli/configuration.md#environment-variables)
-
-### Troubleshooting & Support
-
-- [**Troubleshooting Guide**](./docs/troubleshooting.md) - Common issues and solutions
-- [**FAQ**](./docs/troubleshooting.md#frequently-asked-questions) - Quick answers
-- Use `/bug` command to report issues directly from the CLI
-
-### Using MCP Servers
-
-Configure MCP servers in `~/.gemini/settings.json` to extend Gemini CLI with custom tools:
-
-```text
-> @github List my open pull requests
-> @slack Send a summary of today's commits to #dev channel
-> @database Run a query to find inactive users
+**Build Issues**
+```bash
+# Clean and rebuild
+npm run clean
+npm install
+npm run build
 ```
 
-See the [MCP Server Integration guide](./docs/tools/mcp-server.md) for setup instructions.
-
-## 🤝 Contributing
-
-We welcome contributions! Gemini CLI is fully open source (Apache 2.0), and we encourage the community to:
-
-- Report bugs and suggest features
-- Improve documentation
-- Submit code improvements
-- Share your MCP servers and extensions
-
-See our [Contributing Guide](./CONTRIBUTING.md) for development setup, coding standards, and how to submit pull requests.
-
-Check our [Official Roadmap](https://github.com/orgs/google-gemini/projects/11/) for planned features and priorities.
 
-## 📖 Resources
+## 📄 License
 
-- **[Official Roadmap](./ROADMAP.md)** - See what's coming next
-- **[NPM Package](https://www.npmjs.com/package/@google/gemini-cli)** - Package registry
-- **[GitHub Issues](https://github.com/google-gemini/gemini-cli/issues)** - Report bugs or request features
-- **[Security Advisories](https://github.com/google-gemini/gemini-cli/security/advisories)** - Security updates
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
 
-### Uninstall
+## 🆘 Support
 
-See the [Uninstall Guide](docs/Uninstall.md) for removal instructions.
+- 📚 [Documentation](https://github.com/10cl/shellx-cli)
+- 🐛 [GitHub Issues](https://github.com/10cl/shellx-cli/issues)
+- 📧 [Email Support](mailto:notice@toscl.com)
 
-## 📄 Legal
+## 🙏 Acknowledgments
 
-- **License**: [Apache License 2.0](LICENSE)
-- **Terms of Service**: [Terms & Privacy](./docs/tos-privacy.md)
-- **Security**: [Security Policy](SECURITY.md)
+- **ShellX.ai**: For Android automation infrastructure
+- **Open Source Community**: For contributions and feedback
 
 ---
 
-<p align="center">
-  Built with ❤️ by Google and the open source community
-</p>
+**Made with ❤️ by the ShellX team**

package/bundle/sandbox-macos-permissive-open.sb

@@ -22,4 +22,6 @@
     (literal "/dev/stdout")
     (literal "/dev/stderr")
     (literal "/dev/null")
-)
+    (literal "/dev/ptmx")
+    (regex #"^/dev/ttys[0-9]*$")
+)