code-server/docs/termux.md

Termux

• Termux
  • Installation
  • Upgrading
  • Known Issues
    • Search issue
    • Backspace not working

Termux

Termux is an Android terminal application and Linux environment, which can also run code-server from your phone.

Installation

1. Install Termux from the Google Play Store
2. Make sure it's up-to-date by running apt update && apt upgrade
3. Install required packages: apt install build-essential python git nodejs yarn
4. Install code-server: yarn global add code-server
5. Run code-server: code-server and navigate to localhost:8080 in your browser

Upgrading

To upgrade run: yarn global upgrade code-server --latest

Known Issues

Search issue

There is a known issue with search not working on Android because it's missing bin/rg. To fix:

1. Install ripgrep with pkg

   pkg install ripgrep
   

2. Make a soft link using ln -s

# run this command inside the code-server directory
ln -s $PREFIX/bin/rg ./lib/vscode/node_modules/vscode-ripgrep/bin/rg

For more context, see comment.

Backspace not working

There is a known issue with the backspace key not working correctly when using the on-screen keyboard on Android. This is due to an upstream issue. Read more:

• Issues with Backspace in Codespaces on Android (Surface Duo)
• Support mobile platforms

Workaround: use a Bluetooth keyboard.

For more context, see issues:

• 500 error: 3.9.2 not working on Android + Termux
• Document Android backspace issue