# connectbot

**Repository Path**: fkgte/connectbot

## Basic Information

- **Project Name**: connectbot
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-03
- **Last Updated**: 2026-05-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://github.com/connectbot/connectbot/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/connectbot/connectbot/actions/workflows/ci.yml)

# ConnectBot

ConnectBot is a [Secure Shell](https://en.wikipedia.org/wiki/Secure_Shell)
client for Android that lets you connect to remote servers over a
cryptographically secure link.


## How to Install

### Google Play

[![Get it on Google Play][2]][1]

  [1]: https://play.google.com/store/apps/details?id=org.connectbot
  [2]: https://developer.android.com/images/brand/en_generic_rgb_wo_60.png

The easiest way to get ConnectBot is to [install from Google Play Store][1].
If you have installed from a downloaded APK, Google Play Store can upgrade
your installed version to the latest version. However, once it has upgraded
*you can't install a version from the releases on GitHub anymore* (due to
key rotation that upgrades the package signature to a more secure algorithm).


### Download a release

ConnectBot can be downloaded from [releases](
https://github.com/connectbot/connectbot/releases) on GitHub. There are
two versions:

-  `google` — for a version that uses Google Play Services
   to handle upgrading the cryptography provider
-  `oss` — includes the cryptography provider in the APK which
   increases its size by a few megabytes.

## Architecture

### Major dependencies

The ConnectBot app that uses two other libraries to provide its functionality:
* [ConnectBot Terminal](https://github.com/connectbot/termlib) — the
  terminal emulator used by the app is also created and maintained by the
  ConnectBot author, Kenny Root.
* [ConnectBot fork of Trilead SSH-2](https://github.com/connectbot/sshlib)
  — a heavily modified fork of the original Trilead SSH-2 Java library
  written by Christian Plattner.

## Compiling

### Android Studio

ConnectBot is most easily developed in [Android Studio](
https://developer.android.com/studio/). You can import this project
directly from its project creation screen by importing from the GitHub URL.

### Command line

To compile ConnectBot using `gradlew`, you must first specify where your
Android SDK is via the `ANDROID_SDK_HOME` environment variable. Then
you can invoke the Gradle wrapper to build:

```sh
./gradlew build
```

### Continuous Integration

ConnectBot uses [GitHub Actions](https://github.com/connectbot/connectbot/actions)
for continuous integration. The workflow is defined in
`.github/workflows/ci.yml`.

#### Running Workflows Locally with act

In general, simply running `./gradlew build` should cover all the
checks run in the GitHub Actions continuous integration workflow, but you can
run GitHub Actions workflows locally using [`nektos/act`](https://github.com/nektos/act).
This requires Docker to be installed and running.

To run the main CI workflow (`ci.yml`):

```sh
act -W .github/workflows/ci.yml
```