Installation
System Requirements
Section titled “System Requirements”OxideTerm is a GPU-rendered desktop application. Use a GPU-capable desktop with current graphics drivers.
| Platform | Architectures | Release Formats |
|---|---|---|
| macOS 13+ | arm64, x64 | .dmg, .app.zip, portable .tar.gz |
| Windows | arm64, x64 | NSIS .exe, portable .zip |
| Linux | arm64, x64 | .AppImage, .deb, portable .tar.gz |
Release packages are typically 50–70 MB. OxideTerm does not use a WebView and does not require Chromium, WebView2, WebKitGTK, Node.js, or a JavaScript runtime to launch.
Download
Section titled “Download”Download the latest release from GitHub Releases. Choose the file matching your operating system and CPU architecture.
| Architecture | Installer |
|---|---|
| Apple Silicon | OxideTerm_x.x.x_macos_arm64.dmg |
| Intel | OxideTerm_x.x.x_macos_x64.dmg |
- Open the downloaded disk image.
- Drag OxideTerm to Applications.
- Launch OxideTerm from Applications.
If macOS blocks an unsigned preview build, open System Settings → Privacy & Security and explicitly allow it only after verifying the download source.
Windows
Section titled “Windows”| Architecture | Installer |
|---|---|
| x64 | OxideTerm_x.x.x_windows_x64-setup.exe |
| arm64 | OxideTerm_x.x.x_windows_arm64-setup.exe |
Run the installer and follow the prompts. Portable .zip packages are also published for installations that should not modify the system.
| Architecture | AppImage | Debian Package |
|---|---|---|
| x64 | OxideTerm_x.x.x_linux_x64.AppImage | OxideTerm_x.x.x_linux_x64.deb |
| arm64 | OxideTerm_x.x.x_linux_arm64.AppImage | OxideTerm_x.x.x_linux_arm64.deb |
Install a Debian package with your package manager:
sudo apt install ./OxideTerm_x.x.x_linux_x64.debOr run the AppImage directly:
chmod +x OxideTerm_x.x.x_linux_x64.AppImage./OxideTerm_x.x.x_linux_x64.AppImageBuilding from Source
Section titled “Building from Source”Prerequisites
Section titled “Prerequisites”- A current stable Rust toolchain installed with rustup
- Git
- Platform build tools:
- macOS: Xcode Command Line Tools
- Windows: Visual Studio Build Tools with the MSVC C++ workload
- Linux: the native dependencies installed by
scripts/install-linux-deps.sh
Build Steps
Section titled “Build Steps”git clone https://github.com/AnalyseDeCircuit/oxideterm.gitcd oxideterm
# Linux only: install the repository's native desktop dependencies../scripts/install-linux-deps.sh
cargo build --release -p oxideterm-gpui-appThe desktop executable is written to target/release/oxideterm-native (oxideterm-native.exe on Windows). The standalone CLI can be built with:
cargo build --release -p oxideterm-cliRepository maintainers can create the platform package formats with scripts/package_native.py; the release workflow builds all six macOS, Windows, and Linux architecture targets.
CLI Installation
Section titled “CLI Installation”Release bundles include the oxideterm CLI. Open Settings → General → CLI Companion to install or update it. The app installs it to ~/.local/bin/oxideterm on macOS/Linux or %LOCALAPPDATA%\OxideTerm\bin\oxideterm.exe on Windows.
See the CLI guide for headless management and shell completion.
Updating
Section titled “Updating”Install a newer release package over the current application. Reinstall the CLI from Settings → General → CLI Companion when the settings page reports that the bundled and installed versions differ.
Uninstalling
Section titled “Uninstalling”- macOS: remove OxideTerm from Applications.
- Windows: uninstall OxideTerm from Installed Apps, or delete the portable directory.
- Linux: remove the Debian package with your package manager, or delete the AppImage/portable directory.
Before removing application data, inspect the active paths because profiles and custom data directories can change their location:
oxideterm paths --jsonDelete only the paths reported for the profile you intend to remove. Keychain entries are managed separately by the operating system.