@mmmbuto/gemini-cli-termux 0.20.2-termux → 0.21.0-termux

package/README.md

@@ -1,6 +1,7 @@
-# 🤖 Gemini CLI - Termux Edition
+# 🤖 Gemini CLI – Termux Edition
 
-> **Google Gemini CLI with Android Termux compatibility patches**
+Android/Termux compatible fork of Google Gemini CLI. Installs cleanly on Termux
+by skipping native modules and adding clipboard detection for Termux.
 
 [![npm](https://img.shields.io/npm/v/@mmmbuto/gemini-cli-termux?style=flat-square&logo=npm)](https://www.npmjs.com/package/@mmmbuto/gemini-cli-termux)
 [![downloads](https://img.shields.io/npm/dt/@mmmbuto/gemini-cli-termux?style=flat-square)](https://www.npmjs.com/package/@mmmbuto/gemini-cli-termux)
@@ -10,185 +11,75 @@
 
 ## What This Is
 
-**Temporary fork** of Google Gemini CLI with minimal patches for Android Termux
-compatibility.
+Temporary compatibility fork of `google-gemini/gemini-cli` for Android Termux.
 
-### ⏳ Sunset Plan
+- Tracks upstream regularly.
+- Minimal patches only: Termux clipboard env fix, native modules marked
+  optional.
+- Bundled for ARM64/Android.
+- Sunset: once upstream adds Termux support, migrate back to
+  `@google/gemini-cli`.
 
-We have submitted a PR to upstream Google Gemini CLI to add native Termux
-support. **Once Google merges our fix, this fork will be discontinued** and
-users should migrate to the official `@google/gemini-cli` package.
-
-This fork exists **only** as a temporary solution until official Termux support
-is available.
-
-### What We Do:
-
-✅ **Track official Google Gemini CLI**
-(https://github.com/google-gemini/gemini-cli) ✅ **Apply minimal compatibility
-patches** for Termux-specific issues ✅ **Bundle for Android ARM64** with
-working native module alternatives ✅ **Package as npm** for easy installation
-✅ **Maintain full Apache 2.0 compliance** with Google attribution
-
-### What We DON'T Do:
-
-❌ **NO new features** ❌ **NO behavior modifications** (works exactly like
-upstream) ❌ **NO replacement** of official Gemini CLI
-
-### 🔧 Compatibility Patches
-
-We only apply patches for issues that:
-
-- **Prevent Gemini CLI from working on Termux**
-- **Are not addressed by upstream** (Termux is not officially supported)
-- **Are minimal and well-documented**
-
-**Current patches**:
-
-- `esbuild.config.js`: Auto-set `TERMUX__PREFIX` for clipboardy detection
-- Skip optional native modules: `keytar`, `node-pty`, `tree-sitter-bash`
-- Build with `--ignore-optional --ignore-scripts` flags
-
-See [docs/TERMUX.md](./docs/TERMUX.md) for complete technical details.
-
-**Found an issue?** Open an
-[issue](https://github.com/DioNanos/gemini-cli/issues).
-
----
-
-## 📋 Prerequisites
+## Installation (Termux)
 
 ```bash
-# Update Termux packages
 pkg update && pkg upgrade -y
-
-# Install Node.js
 pkg install nodejs-lts -y
-
-# Verify
-node --version  # v20+
-```
-
-**Requirements:**
-
-- Android 7+ (Termux)
-- ARM64 architecture
-- Node.js ≥ 20.0.0
-- ~25MB storage
-
----
-
-## 📦 Installation
-
-### Via npm (Recommended)
-
-```bash
 npm install -g @mmmbuto/gemini-cli-termux
-```
-
-### Verify Installation
 
-```bash
-gemini --version
-# Output: 0.20.2-termux
-
-gemini --help
-# Shows available commands
+gemini --version  # expected: 0.21.0-termux (latest)
 ```
 
-### Build from Source (Optional)
+Build from source:
 
 ```bash
-git clone https://github.com/DioNanos/gemini-cli.git
-cd gemini-cli
+git clone https://github.com/DioNanos/gemini-cli-termux.git
+cd gemini-cli-termux
 npm install --ignore-optional --ignore-scripts
 npm run build && npm run bundle
 node bundle/gemini.js --version
 ```
 
----
+## Patches
 
-## 🚀 Usage
+- Clipboardy: sets `TERMUX__PREFIX` from `PREFIX` on Android.
+- Native modules (`keytar`, `node-pty`, `tree-sitter-bash`) kept optional;
+  install with `--ignore-optional --ignore-scripts`.
 
-Same as official Gemini CLI. Authentication, commands, and features work
-identically.
+## Known Limitations on Termux
 
-```bash
-# Start interactive mode
-gemini
+- No PTY (node-pty fails to build) → limited shell integration.
+- No secure keychain → credentials stored in plain config files.
+- Bash parsing without tree-sitter.
 
-# Non-interactive mode
-gemini "Explain this codebase"
+## Updating
 
-# Use specific model
-gemini -m gemini-2.5-flash
-
-# Get help
-gemini --help
+```bash
+npm install -g @mmmbuto/gemini-cli-termux@latest
 ```
 
-See [Google's official documentation](https://geminicli.com/docs/) for complete
-usage guide.
-
----
-
-## 📚 Documentation
-
-- **[Termux Installation Guide](docs/TERMUX.md)** - Complete setup and
-  troubleshooting
-- **[Official Gemini CLI Docs](https://geminicli.com/docs/)** - Full feature
-  documentation
-- **[Upstream Repository](https://github.com/google-gemini/gemini-cli)** -
-  Google's official repo
-
----
-
-## 🔄 Upstream Tracking
-
-This fork tracks `google-gemini/gemini-cli` and rebases weekly.
+### Versions
 
-- **Current upstream**: `v0.20.0-nightly.20251201.2fe609cb6`
-- **Last sync**: 2025-12-02
-- **Divergent files**: `esbuild.config.js`, `docs/TERMUX.md`, `package.json`,
-  `README.md`
+- **latest**: 0.21.0-termux (this build)
+- **previous/stable**: 0.20.3-termux (current npm dist-tag until publish)
 
----
-
-## ⚠️ Known Limitations
-
-- **No PTY support** - Interactive shell features may be limited
-- **No secure keychain** - Credentials stored in plain text config files
-- **No tree-sitter bash parsing** - Fallback to simpler shell parsing methods
-
-All core functionality (AI chat, tools, MCP, extensions) works perfectly.
-
----
-
-## 🤝 Contributing
+## Tests
 
-This is a **temporary compatibility fork**. For feature requests or general
-bugs, please report to
-[upstream Gemini CLI](https://github.com/google-gemini/gemini-cli/issues).
+Smoke suite:
 
-For **Termux-specific issues**, open an
-[issue here](https://github.com/DioNanos/gemini-cli/issues).
-
----
-
-## 📄 License
-
-Apache License 2.0 - Same as upstream Google Gemini CLI.
+```bash
+npm run test:termux
+```
 
-**Original project**: Google LLC - https://github.com/google-gemini/gemini-cli
+Checks version, help output, and presence of the Termux clipboard patch inside
+the bundle.
 
-**Termux patches**: @DioNanos - https://github.com/DioNanos/gemini-cli
+## Upstream Tracking
 
----
+- Upstream: https://github.com/google-gemini/gemini-cli
+- Divergent files: `esbuild.config.js`, `docs/TERMUX.md`, `package.json`,
+  `README.md`, `test-gemini/*`
 
-## 🔗 Links
+## License
 
-- **npm Package**: https://www.npmjs.com/package/@mmmbuto/gemini-cli-termux
-- **GitHub Repository**: https://github.com/DioNanos/gemini-cli
-- **Upstream (Google)**: https://github.com/google-gemini/gemini-cli
-- **Latest Release**: https://github.com/DioNanos/gemini-cli/releases/latest
-- **Upstream PR**: Pending Google review for native Termux support
+Apache 2.0 (same as upstream). See LICENSE.