Skip to content

Commit e44ebc8

Browse files
committed
Update README to reflect experimental status and known issues
1 parent 7c126f1 commit e44ebc8

1 file changed

Lines changed: 40 additions & 30 deletions

File tree

README.md

Lines changed: 40 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,58 @@
1-
# Gemini CLI for Termux (Android)
1+
# Gemini CLI on Termux (Experimental)
22

3-
[![License](https://img.shields.io/github/license/google-gemini/gemini-cli)](https://github.com/google-gemini/gemini-cli/blob/main/LICENSE)
4-
[![Fork of](https://img.shields.io/badge/fork%20of-google--gemini%2Fgemini--cli-blue)](https://github.com/google-gemini/gemini-cli)
3+
> [!WARNING]
4+
> This is an **experimental fork** of the official
5+
> [Google Gemini CLI](https://github.com/google-gemini/gemini-cli). While it
6+
> provides a path to run Gemini on Android via Termux, it is currently
7+
> **unstable** and intended for developers and enthusiasts.
58
6-
This is an **explicit fork** of the [Google Gemini CLI](https://github.com/google-gemini/gemini-cli), specifically adapted and optimized for **Android devices running Termux**.
9+
## Status
710

8-
## 📱 Why this fork?
11+
- **Installation**: ✅ Works
12+
- **CLI Startup**: ✅ Works
13+
- **Core Commands**: ⚠️ Partial Implementation
14+
- **Authentication**: ❌ Unstable
915

10-
The original Gemini CLI is designed for desktop environments. This fork introduces several changes to make it work seamlessly on Android:
16+
## Known Issues
1117

12-
- **Termux Browser Support**: Replaced standard browser launching with `termux-open-url` for OAuth authentication.
13-
- **Android-Ready Installer**: A dedicated script to handle Termux-specific dependencies (Node.js LTS, Python, and build tools).
14-
- **Environment Optimization**: Pre-configured to handle the unique filesystem and permission structure of Termux.
18+
- **Authentication Failures**: OAuth and Web API support on Android are
19+
inconsistent, often leading to auth errors.
20+
- **Dependency Issues**: `DOMException` and issues with deprecated Node.js
21+
dependencies in the Termux environment.
22+
- **Stability**: Inconsistent behavior across different Node.js versions and
23+
Android releases.
24+
- **UI Bugs**: Potential infinite scrolling issues when toggling the on-screen
25+
keyboard.
1526

16-
## 🛠️ Installation
27+
## Environment
1728

18-
To install Gemini CLI on your Android device:
29+
- **Platform**: Termux (Android)
30+
- **Node.js**: v20.x / v22.x (Behavior varies)
31+
- **Android**: Version 10+ recommended
1932

20-
1. **Install Termux**: Get it from [F-Droid](https://f-droid.org/en/packages/com.termux/).
21-
2. **Install Termux:API**: Install the [Termux:API app](https://f-droid.org/en/packages/com.termux.api/) and the package:
22-
```bash
23-
pkg install termux-api
24-
```
25-
3. **Run the Installer**:
26-
```bash
27-
curl -sL https://raw.githubusercontent.com/Alex72-py/gemini-cli-termux/master/termux-install.sh | bash
28-
```
33+
## Installation (Termux)
2934

30-
## 🚀 Getting Started
35+
To attempt an installation in your Termux environment, run:
3136

32-
After installation, simply run:
3337
```bash
34-
gemini login
38+
curl -sL https://raw.githubusercontent.com/Alex72-py/gemini-cli-termux/master/termux-install.sh | bash
3539
```
36-
Follow the prompt to authenticate via your mobile browser.
3740

38-
## 📜 Acknowledgments & Credits
41+
## Notes
3942

40-
This project is a derivative work based on the [Gemini CLI](https://github.com/google-gemini/gemini-cli) developed by **Google**.
43+
This repository documents a working but unstable setup to help others
44+
experiment, debug, or improve Gemini CLI support on Termux. It is not
45+
recommended for production use.
4146

42-
- **Original Author**: [Google Gemini Team](https://github.com/google-gemini)
43-
- **License**: This fork maintains the original **Apache License 2.0**.
47+
## Credits & Acknowledgments
4448

45-
We are grateful to the original authors for their incredible work in bringing Gemini to the terminal. This fork aims to extend that power to the mobile developer community.
49+
This project is a fork of the
50+
[Google Gemini CLI](https://github.com/google-gemini/gemini-cli). All core logic
51+
and branding belong to the original Google Gemini team. This fork specifically
52+
adds patches for Termux compatibility.
53+
54+
For a full list of credits, see [CREDITS.md](./CREDITS.md).
4655

4756
---
48-
*Built for the Termux community by Alex72-py.*
57+
58+
_Built for the Termux community by Alex72-py._

0 commit comments

Comments
 (0)