Package Exports
- claude-code-termux
- claude-code-termux/bin/claude-termux.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (claude-code-termux) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Claude Code Termux
A community wrapper for Claude Code CLI that fixes compatibility issues on Termux (Android terminal emulator).
Features
This wrapper addresses the following issues when running Claude Code on Termux:
| Issue | Status | Description |
|---|---|---|
| Sharp module failure | Fixed | Uses WebAssembly fallback for android-arm64 |
| Ripgrep binary missing | Fixed | Auto-downloads or links to system ripgrep |
| Custom slash commands | Fixed | Normalizes paths for Termux filesystem |
| PostToolUse hooks | Fixed | Patches event emission for Android |
| OAuth token storage | Fixed | Provides encrypted file-based fallback |
Requirements
- Termux from F-Droid (NOT Google Play)
- Node.js 18-24 (v25+ has compatibility issues)
- 4GB+ RAM recommended
Quick Install
Run this one-liner in Termux:
curl -fsSL https://raw.githubusercontent.com/findingjimoh/claude-cli-termux/main/scripts/setup-termux.sh | bashOr install manually:
# Update packages
pkg update && pkg upgrade -y
# Install dependencies
pkg install nodejs git ripgrep -y
# Install Claude Code Termux
npm install -g claude-code-termux
# Install Sharp WASM for image support
npm install -g @img/sharp-wasm32 --forceUsage
API Key Authentication (Recommended)
# Set your API key
export ANTHROPIC_API_KEY=your-api-key
# Start Claude Code
claudeTo persist across sessions:
echo 'export ANTHROPIC_API_KEY=your-api-key' >> ~/.bashrcOAuth Authentication (Experimental)
claude loginNote: OAuth has known issues on Termux. API key authentication is more reliable.
Verification
Run the verification script to check your installation:
npx claude-code-termux verify
# or
node /path/to/claude-code-termux/scripts/verify-install.jsTroubleshooting
Sharp Module Error
Error: Could not load the "sharp" module using the android-arm64 runtimeSolution:
npm install -g @img/sharp-wasm32 --force
npm install -g sharp --forceRipgrep Not Found
Error: spawn .../vendor/ripgrep/arm64-android/rg ENOENTSolution:
pkg install ripgrepCustom Slash Commands Not Loading
Ensure your commands are in the correct directory:
mkdir -p ~/.claude/commands
# Create your command files hereMemory/Crash Issues
If you experience crashes:
- Ensure you have enough free RAM (4GB+ recommended)
- Try using an older Node.js version:
pkg install nodejs-lts - Set DEBUG=1 for verbose output:
DEBUG=1 claude
Shell Not Found Error
Error: No suitable shell foundSolution:
export SHELL=/data/data/com.termux/files/usr/bin/bashAdd to ~/.bashrc for persistence.
Known Limitations
- Image reading - Works but requires Sharp WASM installation
- GitHub App installation -
/install-github-appmay not work properly - Some hooks - PostToolUse hooks may have issues on some devices
- Performance - Slightly slower than desktop due to mobile hardware
How It Works
This package is a wrapper around the official @anthropic-ai/claude-code package. It:
- Installs the official Claude Code as a dependency
- Applies runtime patches for Termux compatibility
- Sets up necessary binaries and configurations
- Provides fallback mechanisms for unsupported features
This approach means you automatically get updates from the official package while maintaining Termux compatibility.
Debug Mode
Enable debug output:
DEBUG=1 claudeFor hook-specific debugging:
DEBUG_HOOKS=1 claudeContributing
Contributions are welcome! Please:
- Fork this repository
- Create a feature branch
- Submit a pull request
Related Issues
- Sharp WASM Support #2248
- Custom Commands #9435
- PostToolUse Hooks #15617
- Memory Corruption #12160
- Ripgrep/Auth #6244
License
MIT License - see LICENSE for details.
Disclaimer
This is a community project and is not officially supported by Anthropic. Use at your own risk.