Go to file

agnostic-apollo 4dfed3320e Bump to v0.114		2021-06-11 02:57:56 +05:00
.github	Add termux-shared library to github workflow so that its published	2021-04-07 11:32:22 +05:00
app	Bump to v0.114	2021-06-11 02:57:56 +05:00
art	icon: add regular png icon for compatibility with some launchers	2021-02-03 15:49:03 +02:00
fastlane/metadata/android/en-US	add basic metadata for F-Droid.	2021-02-03 16:43:17 +02:00
gradle/wrapper	Bump gradle to v7.0	2021-04-20 13:05:15 +05:00
terminal-emulator	Bump to v0.114	2021-06-11 02:57:56 +05:00
terminal-view	Bump to v0.114	2021-06-11 02:57:56 +05:00
termux-shared	Bump to v0.114	2021-06-11 02:57:56 +05:00
.editorconfig	Use 2 spaces for yaml files (.travis.yml)	2018-08-30 13:51:24 +02:00
.gitattributes	Update .gitattributes	2021-05-14 08:05:08 +05:00
.gitignore	Include bootstrap zips as shared libraries	2019-10-20 20:15:50 +02:00
LICENSE.md	Update LICENSE.md	2021-05-03 16:08:04 +05:00
README.md	Update README.md	2021-05-03 16:28:02 +05:00
build.gradle	Replace jcenter() with mavenCentral()	2021-04-26 01:11:35 +02:00
gradle.properties	Bump compileSdkVersion (NOT targetSdkVersion) to 30	2021-05-09 21:07:23 +05:00
gradlew	gradle 6.6.1	2020-08-26 20:40:29 +03:00
gradlew.bat	Normalize gradlew.bat	2021-05-14 08:41:15 +05:00
settings.gradle	Create termux-shared library package for all termux constants and shared utils	2021-04-07 11:31:30 +05:00

README.md

Termux application

Termux is an Android terminal application and Linux environment.

Note that this repository is for the app itself (the user interface and the terminal emulation). For the packages installable inside the app, see termux/termux-packages.

Quick how-to about Termux package management is available at Package Management. It also has info on how to fix repository is under maintenance or down errors when running apt or pkg commands.

@termux is looking for Termux Application maintainers for implementing new features, fixing bugs and reviewing pull requests since current one (@fornwall) is inactive.

Issue https://github.com/termux/termux-app/issues/1072 needs extra attention.

Termux App and Plugins
Installation
Uninstallation
Important Links
For Devs and Contributors

Termux App and Plugins

The core Termux app comes with the following optional plugin apps.

Installation

Termux can be obtained through various sources listed below for only Android >= 7. Support was dropped for Android 5 and 6 on 2020-01-01 at v0.83, old builds are available on archive.org.

The APK files of different sources are signed with different signature keys. The Termux app and all its plugins use the same sharedUserId com.termux and so all their APKs installed on a device must have been signed with the same signature key to work together and so they must all be installed from the same source. Do not attempt to mix them together, i.e do not try to install an app or plugin from F-Droid and another one from a different source. Android Package Manager will also normally not allow installation of APKs with a different signatures and you will get errors on installation like App not installed, Failed to install due to an unknown error, INSTALL_FAILED_UPDATE_INCOMPATIBLE, INSTALL_FAILED_SHARED_USER_INCOMPATIBLE, signatures do not match previously installed version, etc. This restriction can be bypassed with root or with custom roms.

If you wish to install from a different source, then you must uninstall any and all existing Termux or its plugin app APKs from your device first, then install all new APKs from the same new source. Check Uninstallation section for details. You may also want to consider Backing up Termux before uninstallation.

F-Droid

Termux application can be obtained from F-Droid here. It usually takes a few days (or even a week or more) for updates to be available on F-Droid once an update has been released on Github. F-Droid releases are built and published by F-Droid once they detect a new Github release. The Termux maintainers do not have any control over building and publishing of Termux app on F-Droid. Moreover, the Termux maintainers also do not have access to the APK signing keys of F-Droid releases, so we cannot release an APK ourselves on Github that would be compatible with F-Droid releases.

Debug Builds

For users who don't want to wait for F-Droid releases and want to try out the latest features immediately or want to test their pull requests can get the APKs from Github Actions page from the workflow runs labeled Build. The APK will be listed under Artifacts section. These are published for each commit done to the repository. These APKs are debuggable and are also not compatible with other sources.

Google Playstore (Deprecated)

Termux and its plugins are no longer updated on Google playstore due to android 10 issues. The last version released for Android >= 7 was v0.101. There are currently no immediate plans to resume updates on Google playstore. It is highly recommended to not install Termux from playstore for now. Any current users should switch to a different source like F-Droid.

If for some reason you don't want to switch, then at least check Package Management to change your mirror, otherwise you will get repository is under maintenance or down errors when running apt or pkg commands. After that, it is also highly advisable to run pkg upgrade command to update all packages to the latest available versions, or at least update termux-tools package with pkg install termux-tools command.

Uninstallation

Uninstallation may be required if a user doesn't want Termux installed in their device anymore or is switching to a different install source. You may also want to consider Backing up Termux before uninstallation.

To uninstall Termux completely, you must uninstall any and all existing Termux or its plugin app APKs listed in Termux App and Plugins.

Go to Android Settings -> Applications and then look for those apps. You can also use the search feature if its available on your device and search termux in the applications list.

Even if you think you have not installed any of the plugins, its strongly suggesting to go through the application list in Android settings and double check.

Important Links

Community

All community links are available here.

The main ones are the following.

Wikis

Miscellaneous

Terminal resources

Terminal emulators

VTE (libvte): Terminal emulator widget for GTK+, mainly used in gnome-terminal. Source, Open Issues, and All (including closed) issues.
iTerm 2: OS X terminal application. Source, Issues and Documentation (which includes iTerm2 proprietary escape codes).
Konsole: KDE terminal application. Source, in particular tests, Bugs and Wishes.
hterm: JavaScript terminal implementation from Chromium. Source, including tests, and Google group.
xterm: The grandfather of terminal emulators. Source.
Connectbot: Android SSH client. Source
Android Terminal Emulator: Android terminal app which Termux terminal handling is based on. Inactive. Source.

For Devs and Contributors

The termux-shared library was added in v0.109. It defines shared constants and utils of Termux app and its plugins. It was created to allow for removal of all hardcoded paths in Termux app. The termux plugins will hopefully use this in future as well. If you are contributing code that is using a constant or a util that may be shared, then define it in termux-shared library if it currently doesn't exist and reference it from there. Update the relevant changelogs as well. Pull requests using hardcoded values will/should not be accepted.

The main Termux constants are defined by TermuxConstants class. It also contains information on how to fork Termux or build it with your own package name. Changing the package name will require building the bootstrap zip packages and other packages with the new $PREFIX, check Building Packages for more info.