@mmmbuto/qwen-code-termux 0.6.1-termux → 0.6.3-termux

package/README.md

@@ -1,7 +1,7 @@
 # 🤖 Qwen Code – Termux Edition
 
 Android/Termux optimized fork of Qwen Code CLI. Installs cleanly on Termux
-by skipping native modules and adding mobile-specific optimizations.
+by skipping native modules and using mobile‑friendly fallbacks.
 
 [![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)
@@ -13,15 +13,9 @@ by skipping native modules and adding mobile-specific optimizations.
 
 **Optimized Termux edition** of `QwenLM/qwen-code`.
 
-This project focuses on maintaining a first-class experience for Qwen Code on
-Android/Termux. It provides critical adaptations for the mobile environment
-while tracking upstream development closely.
-
-- **Termux-First:** Pre-configured for Android filesystem and mobile constraints.
-- **Lightweight:** Native dependencies managed for ARM64 without complex
-  compilation.
-- **Up-to-Date:** Synchronized with the latest Qwen Code features.
-- **Qwen3-Coder Optimized:** Best performance with Qwen3-Coder models.
+- **Termux‑First:** Android filesystem and shell fallbacks.
+- **Lightweight:** No native PTY/keychain deps.
+- **Up‑to‑Date:** Tracks upstream Qwen Code.
 
 ## Installation (Termux)
 
@@ -30,7 +24,7 @@ pkg update && pkg upgrade -y
 pkg install nodejs-lts -y
 npm install -g @mmmbuto/qwen-code-termux
 
-qwen --version  # expected: 0.6.0-termux
+qwen --version  # expected: 0.6.3-termux
 ```
 
 Build from source:
@@ -40,54 +34,21 @@ git clone https://github.com/DioNanos/qwen-code-termux.git
 cd qwen-code-termux
 npm install --ignore-optional --ignore-scripts
 npm run build && npm run bundle
-node bundle/qwen.js --version
+node dist/cli.js --version
 ```
 
-## Termux Optimizations
-
-- **Smart Clipboard:** Auto-detects Android environment to enable seamless
-  clipboard operations (fixes `TERMUX__PREFIX`).
-- **Streamlined Install:** Native PTY/keychain deps are **omitted** on Termux
-  (fallback to `child_process` + file-based tokens), avoiding native builds.
-- **Clean UX:** Suppresses desktop-centric warnings (like home directory checks)
-  to optimize the experience for mobile terminal usage.
-- **ARM64 Native:** Bundled specifically for Android architecture.
-- **Responsive Settings:** Fixed settings dialog layout for small screens.
-
-## Environment Specifics
-
-- **Shell Integration:** Uses robust `child_process` fallback instead of
-  `node-pty` for maximum stability on Android.
-- **Credentials:** Keys are stored in standard config files for portability (no
-  dependency on system keychains).
-- **Qwen OAuth:** Full OAuth support with free tier (2000 requests/day).
-- **OpenAI Compatible:** Can use OpenAI-compatible APIs.
-
 ## Quick Start
 
 ```bash
-# Start Qwen Code (interactive)
 qwen
-
-# Then, in the session:
+# then
 /help
 /auth
 ```
 
-On first use, you'll be prompted to sign in. You can run `/auth` anytime to switch authentication methods.
-
-Example prompts:
-
-```text
-What does this project do?
-Explain the codebase structure.
-Help me refactor this function.
-Generate unit tests for this module.
-```
-
 ## Authentication
 
-Qwen Code Termux supports two authentication methods:
+Qwen Code supports two authentication methods:
 
 - **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).
@@ -100,11 +61,11 @@ Start `qwen`, then run:
 /auth
 ```
 
-Choose **Qwen OAuth** and complete the browser flow.
+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)
 
-Environment variables:
+Environment variables (recommended for CI / headless environments):
 
 ```bash
 export OPENAI_API_KEY="your-api-key-here"
@@ -112,6 +73,19 @@ export OPENAI_BASE_URL="https://api.openai.com/v1"  # optional
 export OPENAI_MODEL="gpt-4o"                        # optional
 ```
 
+## 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).
+
+## Documentation & Fixes
+
+- **Test Suite**: [`QWEN_TEST_SUITE.md`](./QWEN_TEST_SUITE.md)
+- **Test Report**: [`QWEN_TEST_REPORT_v0.6.3.md`](./QWEN_TEST_REPORT_v0.6.3.md)
+- **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:
@@ -121,37 +95,46 @@ As an open-source terminal agent, you can use Qwen Code in four primary ways:
 3. IDE integration (VS Code, Zed)
 4. TypeScript SDK
 
-### Interactive mode
+#### Interactive mode
 
 ```bash
 cd your-project/
 qwen
 ```
 
-Run `qwen` in your project folder to launch the interactive terminal UI. Use `@` to reference local files.
+Run `qwen` in your project folder to launch the interactive terminal UI. Use `@` to reference local files (for example `@src/main.ts`).
 
-### Headless mode
+#### Headless mode
 
 ```bash
 cd your-project/
 qwen -p "your question"
 ```
 
-Use `-p` to run Qwen Code without the interactive UI—ideal for scripts and automation.
+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/)
 
-### IDE integration
+#### TypeScript SDK
 
-Use Qwen Code inside your editor (VS Code and Zed) - see upstream documentation.
+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
-- `/settings` - Configure Qwen Code (including hide banner)
 - `/clear` - Clear conversation history
-- `/auth` - Switch authentication method
+- `/compress` - Compress history to save tokens
 - `/stats` - Show current session information
+- `/bug` - Submit a bug report
 - `/exit` or `/quit` - Exit Qwen Code
 
 ### Keyboard Shortcuts
@@ -160,84 +143,39 @@ Use Qwen Code inside your editor (VS Code and Zed) - see upstream documentation.
 - `Ctrl+D` - Exit (on empty line)
 - `Up/Down` - Navigate command history
 
-## Configuration
-
-Qwen Code can be configured via `settings.json`, environment variables, and CLI flags.
-
-- **User settings**: `~/.qwen/settings.json`
-- **Project settings**: `.qwen/settings.json`
-
-Key settings available in `/settings`:
-
-- `ui.hideBanner` - Hide the welcome banner
-- `ui.hideTips` - Hide tips display
-- `tools.approvalMode` - Control tool approval behavior
-
-## Termux-Specific Changes
-
-### v0.6.0-termux Modifications
-
-This fork includes specific optimizations for Android/Termux:
-
-**UI/UX Fixes:**
-
-- **Responsive Settings Layout** - Fixed settings dialog for small screens (smartphones)
-  - Changed `minWidth={50}` to `flexGrow={1}` for adaptive labels
-  - Values no longer overflow on narrow terminals
-- **Banner System** - Full banner component integration with hideBanner support
-  - `ThemedGradient.tsx` - Gradient theme for banner first line
-  - `Banner.tsx` - Dynamic warning/info banner display
-  - `useBanner.ts` - Smart banner counting (max 5 shows)
-  - `persistentState.ts` - State persistence across sessions
+> Learn more about [Commands](https://qwenlm.github.io/qwen-code-docs/en/users/features/commands/)
 
-**Termux Tools Integration:**
+## Updating
 
-- `scripts/termux-tools/discovery.sh` - Discovers 20+ Termux-API tools
-- `scripts/termux-tools/call.sh` - Dispatcher for tool execution
+```bash
+npm install -g @mmmbuto/qwen-code-termux@latest
+```
 
-**Available Termux Tools:**
+### Versions
 
-| Tool                          | Description                             |
-| ----------------------------- | --------------------------------------- |
-| `termux_battery_status`       | Battery %, health, temp, charging state |
-| `termux_clipboard_get/set`    | Read/write Android clipboard            |
-| `termux_toast`                | Show toast notification on screen       |
-| `termux_notification`         | Create persistent notification          |
-| `termux_tts_speak`            | Text-to-speech with language/pitch/rate |
-| `termux_vibrate`              | Vibrate device                          |
-| `termux_torch`                | Control camera flash                    |
-| `termux_wifi_scan/connection` | WiFi info                               |
-| `termux_location`             | GPS location                            |
-| `termux_camera_info/photo`    | Camera access                           |
-| `termux_dialog`               | Text input dialog                       |
-| `termux_telephony_call`       | Initiate phone call                     |
-| `termux_sensor_info/read`     | Read device sensors                     |
+- **latest / stable**: 0.6.3-termux
 
-**npm Install Optimizations:**
+## Benchmark Results
 
-- `os: ["android", ...]` - Allows Termux installs
-- `cpu: ["arm64", ...]` - Targets Android architecture
-- Minimal postinstall message: `✓ qwen-code-termux installed`
+### Terminal-Bench Performance
 
-## Testing
+| Agent     | Model              | Accuracy |
+| --------- | ------------------ | -------- |
+| Qwen Code | Qwen3-Coder-480A35 | 37.5%    |
+| Qwen Code | Qwen3-Coder-30BA3B | 31.3%    |
 
-See `QWEN_TEST_SUITE.md` for post-install testing instructions.
+## Ecosystem
 
-## Patches Documentation
+Looking for a graphical interface?
 
-See `docs/patches/README.md` for complete list of Termux-specific modifications.
+- [**AionUi**](https://github.com/iOfficeAI/AionUi) A modern GUI for command-line AI tools including Qwen Code
+- [**Gemini CLI Desktop**](https://github.com/Piebald-AI/gemini-cli-desktop) A cross-platform desktop/web/mobile UI for Qwen Code
 
-## Updating
-
-```bash
-npm install -g @mmmbuto/qwen-code-termux@latest
-```
+## Troubleshooting
 
-## Upstream Tracking
+If you encounter issues, check the [troubleshooting guide](https://qwenlm.github.io/qwen-code-docs/en/users/support/troubleshooting/).
 
-- Upstream: https://github.com/QwenLM/qwen-code
-- Fork: https://github.com/DioNanos/qwen-code-termux
-- Base: Google Gemini CLI architecture
+To report a bug from within the CLI, run `/bug` and include a short title and repro steps.
 
 ## License
 
@@ -245,5 +183,5 @@ Apache 2.0 (same as upstream). See LICENSE.
 
 ## Acknowledgments
 
-This project is based on [Qwen Code](https://github.com/QwenLM/qwen-code), which is based on [Google Gemini CLI](https://github.com/google-gemini/gemini-cli).
-Termux-specific optimizations by DioNanos.
+Based on [Qwen Code](https://github.com/QwenLM/qwen-code), which is based on
+[Google Gemini CLI](https://github.com/google-gemini/gemini-cli).