@mmmbuto/qwen-code-termux 0.6.407-termux → 0.10.3-termux

package/README.md

@@ -1,204 +1,108 @@
-# 🤖 Qwen Code – Termux Edition
+<div align="center">
 
-Android/Termux optimized fork of Qwen Code CLI. Installs cleanly on Termux
-with a native ARM64 PTY prebuild and mobile‑friendly fallbacks.
+[![npm version](https://img.shields.io/npm/v/@mmmbuto/qwen-code-termux.svg)](https://www.npmjs.com/package/@mmmbuto/qwen-code-termux)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
+[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg)](https://nodejs.org/)
+[![Downloads](https://img.shields.io/npm/dm/@mmmbuto/qwen-code-termux.svg)](https://www.npmjs.com/package/@mmmbuto/qwen-code-termux)
+[![Ko-fi](https://img.shields.io/badge/Ko--fi-Support%20me-ff5e5b?logo=ko-fi&logoColor=white)](https://ko-fi.com/dionanos)
 
-[![npm](https://img.shields.io/npm/v/@mmmbuto/qwen-code-termux?style=flat-square&logo=npm)](https://www.npmjs.com/package/@mmmbuto/qwen-code-termux)
-[![downloads](https://img.shields.io/npm/dt/@mmmbuto/qwen-code-termux?style=flat-square)](https://www.npmjs.com/package/@mmmbuto/qwen-code-termux)
-[![ko-fi](https://img.shields.io/badge/☕_Support-Ko--fi-FF5E5B?style=flat-square&logo=ko-fi)](https://ko-fi.com/dionanos)
+**An open-source AI agent that lives in your terminal — Termux Edition (Android).**
 
----
+<a href="https://qwenlm.github.io/qwen-code-docs/zh/users/overview">中文</a> |
+<a href="https://qwenlm.github.io/qwen-code-docs/de/users/overview">Deutsch</a> |
+<a href="https://qwenlm.github.io/qwen-code-docs/fr/users/overview">français</a> |
+<a href="https://qwenlm.github.io/qwen-code-docs/ja/users/overview">日本語</a> |
+<a href="https://qwenlm.github.io/qwen-code-docs/ru/users/overview">Русский</a> |
+<a href="https://qwenlm.github.io/qwen-code-docs/pt-BR/users/overview">Português (Brasil)</a>
 
-## What This Is
+</div>
 
-**Optimized Termux edition** of `QwenLM/qwen-code`.
+Qwen Code is an open-source AI agent for the terminal, optimized for **Qwen3-Coder**.  
+This repository/package is a **Termux-first build** that keeps upstream behavior, while fixing the parts that commonly break on Android/Termux (notably PTY and a few runtime quirks).
 
-- **Termux‑First:** Android filesystem and shell fallbacks.
-- **Lightweight:** PTY via `@mmmbuto/node-pty-android-arm64`, no keychain deps.
-- **Up‑to‑Date:** Tracks upstream Qwen Code.
+> **Not on Termux?** Use upstream: `npm install -g @qwen-code/qwen-code@latest` (or Homebrew).  
+> **On Termux?** Use this package: `npm install -g @mmmbuto/qwen-code-termux@latest`.
 
-## Installation (Termux)
+![](https://gw.alicdn.com/imgextra/i1/O1CN01D2DviS1wwtEtMwIzJ_!!6000000006373-2-tps-1600-900.png)
 
-```bash
-pkg update && pkg upgrade -y
-pkg install nodejs-lts -y
-npm install -g @mmmbuto/qwen-code-termux
+## Why a Termux Edition?
 
-qwen --version  # expected: 0.6.405-termux
-```
+Upstream Qwen Code targets macOS/Linux/Windows. On Android/Termux, installs may fail due to native dependency issues (PTY / build tooling) and small environment differences.
 
-Build from source:
+Termux Edition focuses on:
 
-```bash
-git clone https://github.com/DioNanos/qwen-code-termux.git
-cd qwen-code-termux
-npm install
-npm run build && npm run bundle
-node dist/cli.js --version
-```
+- **Android PTY support** via `@mmmbuto/node-pty-android-arm64` (optional dependency)
+- **Termux runtime patches** (polyfills/quirks, clipboard behavior)
+- **Termux-safe install** (avoid node-gyp/husky pitfalls where possible)
+- **Tested on-device** — see [test-reports/0.10.3-termux/](test-reports/0.10.3-termux/README.md)
 
-## Quick Start
+## Installation (Termux / Android)
 
-```bash
-qwen
-# then
-/help
-/auth
-```
-
-## Authentication
-
-Qwen Code supports two authentication methods:
+### Prerequisites
 
-- **Qwen OAuth (recommended & free)**: sign in with your `qwen.ai` account in a browser.
-- **OpenAI-compatible API**: use `OPENAI_API_KEY` (and optionally a custom base URL / model).
-
-### Qwen OAuth (recommended)
-
-Start `qwen`, then run:
+- Termux (recommended from F-Droid)
+- Node.js **20+** (Termux `nodejs-lts` is recommended)
 
 ```bash
-/auth
+pkg update -y && pkg upgrade -y
+pkg install -y nodejs-lts git
 ```
 
-Choose **Qwen OAuth** and complete the browser flow. On Termux, the browser opens via `termux-open-url` with an Android fallback. Your credentials are cached locally.
-
-### OpenAI-compatible API (API key)
+Optional (recommended) for extra tools:
 
-Environment variables (recommended for CI / headless environments):
+- Install the **Termux:API** Android app
+- Install the Termux package:
 
 ```bash
-export OPENAI_API_KEY="your-api-key-here"
-export OPENAI_BASE_URL="https://api.openai.com/v1"  # optional
-export OPENAI_MODEL="gpt-4o"                        # optional
+pkg install -y termux-api
 ```
 
-## Termux Optimizations
-
-- **OAuth:** browser launch via `termux-open-url` with Android fallback.
-- **Clean UX:** desktop‑centric warnings suppressed on Termux.
-- **Defaults:** banner hidden by default on Termux (toggle in settings).
-- **PTY:** prebuilt `@mmmbuto/node-pty-android-arm64` for interactive shells.
-
-## Documentation & Fixes
-
-- **Test Suite**: [`QWEN_TEST_SUITE.md`](./QWEN_TEST_SUITE.md)
-- **Test Report**: [`QWEN_TEST_REPORT_v0.6.405-termux.md`](./QWEN_TEST_REPORT_v0.6.405-termux.md)
-  (latest report; 0.6.405-termux)
-- **Patches**: [`docs/patches/README.md`](./docs/patches/README.md)
-- **Termux Fixes**: [`docs/patches/TERMUX_FIXES.md`](./docs/patches/TERMUX_FIXES.md)
-
-## Usage
-
-As an open-source terminal agent, you can use Qwen Code in four primary ways:
-
-1. Interactive mode (terminal UI)
-2. Headless mode (scripts, CI)
-3. IDE integration (VS Code, Zed)
-4. TypeScript SDK
-
-#### Interactive mode
-
-```bash
-cd your-project/
-qwen
-```
-
-Run `qwen` in your project folder to launch the interactive terminal UI. Use `@` to reference local files (for example `@src/main.ts`).
-
-#### Headless mode
+### Install
 
 ```bash
-cd your-project/
-qwen -p "your question"
+npm install -g @mmmbuto/qwen-code-termux@latest
+qwen --version
 ```
 
-Use `-p` to run Qwen Code without the interactive UI—ideal for scripts, automation, and CI/CD. Learn more: [Headless mode](https://qwenlm.github.io/qwen-code-docs/en/users/features/headless).
-
-#### IDE integration
-
-Use Qwen Code inside your editor (VS Code and Zed):
-
-- [Use in VS Code](https://qwenlm.github.io/qwen-code-docs/en/users/integration-vscode/)
-- [Use in Zed](https://qwenlm.github.io/qwen-code-docs/en/users/integration-zed/)
-
-#### TypeScript SDK
-
-Build on top of Qwen Code with the TypeScript SDK:
-
-- [Use the Qwen Code SDK](./packages/sdk-typescript/README.md)
-
-## Commands & Shortcuts
-
-### Session Commands
-
-- `/help` - Display available commands
-- `/clear` - Clear conversation history
-- `/compress` - Compress history to save tokens
-- `/stats` - Show current session information
-- `/bug` - Submit a bug report
-- `/exit` or `/quit` - Exit Qwen Code
-
-### Keyboard Shortcuts
-
-- `Ctrl+C` - Cancel current operation
-- `Ctrl+D` - Exit (on empty line)
-- `Up/Down` - Navigate command history
-
-> Learn more about [Commands](https://qwenlm.github.io/qwen-code-docs/en/users/features/commands/)
-
-## Updating
+## Quick Start
 
 ```bash
-npm install -g @mmmbuto/qwen-code-termux@latest
+qwen              # Interactive
+qwen -p "Hello"   # Non-interactive
+qwen /help        # Commands
+qwen /auth        # Authentication
 ```
 
-### Versions
-
-- **latest / stable**: 0.6.405-termux
-
-## Benchmark Results
-
-### Terminal-Bench Performance
+## Resources
 
-| Agent     | Model              | Accuracy |
-| --------- | ------------------ | -------- |
-| Qwen Code | Qwen3-Coder-480A35 | 37.5%    |
-| Qwen Code | Qwen3-Coder-30BA3B | 31.3%    |
+- **Test Reports**: [test-reports/0.10.3-termux/](test-reports/0.10.3-termux/README.md)
+- **Patches**: [patches/](patches/README.md)
+- **Build**: [docs/developers/BUILDING.md](docs/developers/BUILDING.md)
+- **Config**: [docs/users/configuration.md](docs/users/configuration.md)
 
-## Ecosystem
+---
 
-Looking for a graphical interface?
+## Changelog & Releases
 
-- Web UI: [NexusCLI](https://github.com/DioNanos/nexuscli) - Optional web interface for Codex/Claude/Gemini
+- [CHANGELOG.md](./CHANGELOG.md)
 
 ## Troubleshooting
 
-If you encounter issues, check the [troubleshooting guide](https://qwenlm.github.io/qwen-code-docs/en/users/support/troubleshooting/).
-
-To report a bug from within the CLI, run `/bug` and include a short title and repro steps.
+If you encounter issues, check the [upstream troubleshooting guide](https://qwenlm.github.io/qwen-code-docs/en/users/support/troubleshooting/).
 
-## License
+To report a bug from within the CLI, run `/bug`.
 
-Apache 2.0 (same as upstream). See LICENSE.
+## Support
 
-## Acknowledgments
+If this Termux edition helps you, you can support the project on Ko-fi:
 
-Based on [Qwen Code](https://github.com/QwenLM/qwen-code), which is based on
-[Google Gemini CLI](https://github.com/google-gemini/gemini-cli).
+- https://ko-fi.com/dionanos
 
-## PTY Support (Shared Library)
+## Connect with Upstream
 
-This project uses `@mmmbuto/pty-termux-utils` as a shared library for PTY
-management across all Termux CLI projects (Gemini, Qwen, Nexus).
+- Discord: https://discord.gg/ycKBjdNd
+- Dingtalk: https://qr.dingtalk.com/action/joingroup?code=v1,k1,+FX6Gf/ZDlTahTIRi8AEQhIaBlqykA0j+eBKKdhLeAE=&_dt_no_comment=1&origin=1
 
-- **Native PTY:** Uses `@mmmbuto/node-pty-android-arm64@~1.1.0` when available
-- **Linux ARM64:** Uses `@lydell/node-pty-linux-arm64@~1.2.0-beta.2` when available
-- **Fallback:** Gracefully degrades to `child_process` adapter
-- **Debug Logging:** Enable with `PTY_DEBUG=1` environment variable
-- **Architecture:** See `@mmmbuto/pty-termux-utils` documentation
+## Acknowledgments
 
-```bash
-# Enable PTY debug logging
-PTY_DEBUG=1 qwen "your prompt"
-```
+This project is based on [Google Gemini CLI](https://github.com/google-gemini/gemini-cli). We acknowledge and appreciate the excellent work of the Gemini CLI team. Our main contribution focuses on parser-level adaptations to better support Qwen-Coder models.