Install

Release status

The latest published release is 0.3.2, and the install script below installs it. The other pages of this documentation describe newer code that is not published yet: it is not in a release and not on a public branch. That code adds the agent socket, the audit log, the policy markers (protected and ai_control), --dry-run and the adapters. Release 0.3.2 has none of them: oxidepm --dry-run status is refused there, and notifications are still built into the core instead of coming from the notifier adapter.

There is nothing to build from source yet to try what these pages describe: the repository's default branch builds the 0.3 line, not that code. This section goes away when a release contains it.

Requirements

• Linux (the main platform). The process manager is also built for macOS on Apple Silicon, but it is not tested there, and adapters, the sandbox and the recovery of apps after the daemon is killed are Linux only. Windows is not supported.
• Rust 1.75 or newer, only to build from source.
• The runtimes of the apps you want to run, and only those: Node.js for Node, npm, pnpm and yarn apps, Python 3 for Python apps, Go 1.21 or newer for Go apps.

The install script

curl -fsSL https://oxidepm.com/install.sh | sh

The script is install.sh; read it before you run it. It installs the latest published release, which is 0.3.2 today. This is everything it does:

1. Works out your platform from uname: Linux on x86_64 or aarch64, macOS on arm64 (Apple Silicon). Anything else stops with an error. For an Intel Mac the error says that no build is published.
2. Asks the GitHub releases API of the OxidePM repository for the tag of the latest release.
3. Downloads oxidepm-<target>.tar.gz and checksums.txt from that release on github.com.
4. Checks that the archive's SHA-256 is the one checksums.txt lists for that exact file name. This shows the file arrived whole and is the one the release lists. It is not a signature check, and there is no release signing key yet.
5. Unpacks the archive in a temporary directory and moves oxidepm, oxidepmd and, if the archive has it, oxidepm-sandbox into /usr/local/bin, using sudo when that directory is not writable. Set INSTALL_DIR to install somewhere else.
6. Runs oxidepm --version.

Apart from the redirects GitHub answers with to its download host, it makes no other request and installs nothing else.

Other ways

The Releases page has the archives and Debian packages:

There is no archive for Intel Macs. The repository README also mentions a Homebrew tap and an Arch Linux package description; they have not been checked for this site, so follow the README for them.

From source

git clone https://github.com/oxidekit/oxidepm
cd oxidepm
cargo build --workspace --release

This builds the published 0.3 line, which does not have the features this documentation describes as not yet released. The binaries are in target/release. Put oxidepm and oxidepmd in one directory on your PATH: the CLI starts the daemon from the directory it is in. A build that includes the adapter sandbox also has oxidepm-sandbox, which the CLI looks for next to itself.

Check it

oxidepm --version
oxidepm status

Before anything is started, status answers that the daemon is not running. The daemon starts the first time you start an app.