INSTALLATION GUIDE

Install BanchoXterm

Step-by-step Windows installation and building from source on Linux.

Windows: installer or portable

Open the releases page and download the Windows file for your architecture. Choose the installer or the portable edition.

View downloads on GitHub ↗

Using the installer

Download the .exe installer from GitHub Releases.
Run the installer and follow the setup wizard.
Open BanchoXterm from the Start menu.

Portable edition

Download the Windows portable ZIP.
Extract all files into a folder where you have write permission.
Run banchoxterm.exe from that folder. Keep the bundled files and subfolders.

Build on Windows with MSVC

Git and CMake.
Visual Studio 2022 or Build Tools with Desktop development with C++.
64-bit MSVC Qt with SerialPort and ActiveQt.

Open x64 Native Tools Command Prompt for VS 2022.

Download the source and submodules.

git clone --recurse-submodules https://github.com/Gargadon/banchoxterm.git
cd banchoxterm

Adjust the Qt path to your installation, build and run.

cmake -B build-msvc -G "Visual Studio 17 2022" -A x64 -DCMAKE_PREFIX_PATH=C:/Qt/6.8.3/msvc2022_64
cmake --build build-msvc --config Release
build-msvc\Release\banchoxterm.exe

Linux: build from source

The project does not publish Linux packages yet. You need Git, CMake 3.16 or later, a C++17 compiler, Qt 6.6 or later, and the FreeRDP 3 and WinPR 3 development dependencies.

1. Install dependencies

Ubuntu / Debian

sudo apt update
sudo apt install git build-essential cmake ninja-build \
  qt6-base-dev qt6-serialport-dev qt6-tools-dev qt6-tools-dev-tools \
  libssl-dev zlib1g-dev libsecret-tools lrzsz pkg-config \
  freerdp3-dev libwinpr3-dev

Fedora

sudo dnf install git gcc-c++ cmake ninja-build \
  qt6-qtbase-devel qt6-qtserialport-devel qt6-qttools-devel \
  openssl-devel zlib-devel libsecret lrzsz pkgconf-pkg-config \
  freerdp-devel winpr-devel

2. Get the source and submodules

The QTermWidget submodule is required. The HTTPS URL lets you clone without setting up a GitHub SSH key.

git clone --recurse-submodules https://github.com/Gargadon/banchoxterm.git
cd banchoxterm

3. Build and run

CMake downloads bundled libraries through FetchContent, so the first build needs Internet access. Run these commands inside the banchoxterm folder.

cmake -B build -G Ninja
cmake --build build
./build/banchoxterm

Save passwords on Linux

You need secret-tool and an active Secret Service provider in your desktop session. Use your desktop’s credential manager; if you do not have one, install GNOME Keyring or a compatible KWallet provider. You do not need both.

macOS: untested features

None of the BanchoXterm features have been tested on macOS. If you choose to build or use it on this system, evaluate its behavior at your own risk.

Your first connection

Create an SSH session and enter the server host, port and username.
Select your private key or enter a password. You can save it in the credential manager.
Verify the server fingerprint before trusting it, then connect.

Optional: X11 and serial console

For X11 on Windows, you can use VcXsrv, Xming or X410. To send files over ZMODEM in serial sessions, install lrzsz on Linux.