Getting Started

Installation

Install Xentom on your system to get started with workflow development.

Overview

Xentom is distributed as a single standalone executable with no external dependencies. It can be installed via script, package manager, or Docker on macOS, Linux, and Windows.

Installation

Terminal
curl -fsSL https://xentom.com/install | bash

Linux users

The unzip package is required to install the Xentom CLI. Install it using your package manager:

  • Ubuntu/Debian: sudo apt install unzip
  • CentOS/RHEL: sudo yum install unzip or sudo dnf install unzip
  • Arch Linux: sudo pacman -S unzip
PowerShell
powershell -c "irm xentom.com/install.ps1 | iex"

Xentom requires Windows 10 version 1809 or later.

Xentom provides a Docker image that supports both Linux x64 and arm64.

Terminal
docker pull ghcr.io/xentom/xentom
docker run --rm --init -p 3000:3000 ghcr.io/xentom/xentom

Security Note

Always review installation scripts before running them. You can inspect our script at xentom.com/install or xentom.com/install.ps1 before execution.

Verify Installation

After installation, verify that Xentom is working correctly:

Terminal
xentom --version
# Output: 1.x.y

# See the precise commit of Xentom that you're using
xentom --revision
# Output: 1.x.y+398131031

If you've installed Xentom but are seeing a command not found error, you may have to manually add the installation directory (~/.xentom/bin) to your PATH.

Upgrading

Once installed, Xentom can upgrade itself:

Terminal
# Upgrade to latest stable version
xentom upgrade

Canary Builds (Beta Features)

Want to try the latest features? Upgrade to our canary build:

Terminal
xentom upgrade --canary

About Canary Builds:

  • Released automatically on every commit to main
  • Contains the latest features and bug fixes
  • May be unstable - use with caution in production
  • Automatically reports crashes to help improve Xentom
  • Ideal for testing and providing feedback

To switch back to stable releases:

Terminal
xentom upgrade --stable