Installation
System Requirements
Section titled “System Requirements”| Platform | Minimum Version | Architecture |
|---|---|---|
| macOS | 11.0 (Big Sur) | Apple Silicon (M1+), Intel x64 |
| Windows | 10 (1803+) | x64, ARM64 |
| Linux | Ubuntu 22.04+ / Fedora 38+ | x64, ARM64 |
Download
Section titled “Download”Download the latest release from GitHub Releases.
| Variant | File |
|---|---|
| Apple Silicon (M-series) | OxideTerm_x.x.x_aarch64.dmg |
| Intel | OxideTerm_x.x.x_x64.dmg |
- Download the
.dmgfile for your architecture - Open the disk image and drag OxideTerm to your Applications folder
- On first launch, open Terminal and run
xattr -cr /Applications/OxideTerm.appto remove the quarantine flag, then launch normally
Windows
Section titled “Windows”| Variant | File |
|---|---|
| x64 | OxideTerm_x.x.x_x64-setup.exe |
| ARM64 | OxideTerm_x.x.x_arm64-setup.exe |
- Download the
.exeinstaller - Run the installer and follow the prompts
- OxideTerm will be available in the Start Menu
| Variant | File |
|---|---|
| x64 (Debian/Ubuntu) | OxideTerm_x.x.x_amd64.deb |
| x64 (AppImage) | OxideTerm_x.x.x_amd64.AppImage |
| ARM64 (Debian/Ubuntu) | OxideTerm_x.x.x_arm64.deb |
| ARM64 (AppImage) | OxideTerm_x.x.x_arm64.AppImage |
Debian/Ubuntu:
sudo dpkg -i OxideTerm_x.x.x_amd64.debAppImage:
chmod +x OxideTerm_x.x.x_amd64.AppImage./OxideTerm_x.x.x_amd64.AppImageBuilding from Source
Section titled “Building from Source”Prerequisites
Section titled “Prerequisites”- Rust 1.75+ (install via rustup)
- Node.js 18+
- pnpm (install via
npm install -g pnpm) - Platform-specific build tools:
- macOS: Xcode Command Line Tools
- Windows: Visual Studio Build Tools 2019+
- Linux:
build-essential,libwebkit2gtk-4.1-dev,libssl-dev
Build Steps
Section titled “Build Steps”# Clone the repositorygit clone https://github.com/AnalyseDeCircuit/oxideterm.gitcd oxideterm
# Install dependenciespnpm install
# Development mode (hot reload)pnpm tauri dev
# Production buildpnpm tauri buildThe built application will be in src-tauri/target/release/bundle/.
Updating
Section titled “Updating”OxideTerm includes a built-in auto-update mechanism. When a new version is available, you’ll see an update notification in the app. You can also manually check for updates in Settings.
Uninstalling
Section titled “Uninstalling”- macOS: Drag OxideTerm from Applications to Trash
- Windows: Use Add/Remove Programs in Settings
- Linux:
sudo dpkg -r oxidetermor delete the AppImage file
Configuration data is stored in:
- macOS:
~/Library/Application Support/com.oxideterm.app/ - Windows:
%APPDATA%\com.oxideterm.app\ - Linux:
~/.config/com.oxideterm.app/