Introduction

Installation

Install the dxcore CLI binary and connect it to your coordinator.

Installing the CLI

The dxcore binary is an Elixir escript. There is no npm package — it is distributed as a standalone binary.

Pre-built Binary

Download the latest release for your platform from the releases page and place it on your PATH:

curl -fsSL https://github.com/join-with/dxcore/releases/latest/download/dxcore-agents-cli-linux-x86_64 \
  -o /usr/local/bin/dxcore
chmod +x /usr/local/bin/dxcore

Build from Source

If you have Elixir installed, you can build from source:

cd apps/dxcore-agents-cli
mix deps.get
mix escript.build

This produces a dxcore binary in the current directory.

Verify Installation

Running dxcore with no valid subcommand prints usage and exits:

Usage: dxcore <command> [options]

Commands:
  agent      Start an agent worker
  dispatch   Submit a task graph to the coordinator
  ci         CI lifecycle helpers (create-session, wait, finish, shutdown)
  config     Inspect resolved configuration

Coordinator Access

Every CLI command requires a coordinator URL and a bearer token. Pass these as flags on each command:

dxcore dispatch -c https://dxcore.example.com -t your-api-token ...
dxcore agent    -c https://dxcore.example.com -t your-api-token ...

Important

The coordinator URL must be reachable from your CI runners. If you are using DxCore SaaS, you will receive your coordinator URL and API token after creating an organization.

CI Runner Setup

In CI, agents typically run on parallel job nodes. Each node needs:

The dxcore binary on the PATH
A checked-out copy of the repository
Network access to the coordinator

See GitHub Actions integration for a complete CI setup example.