—Start here

Getting started with Axiom Agent.

Download the desktop application, verify the installer, complete browser-assisted desktop authentication, and configure only the integrations your workflow needs.

The installed app is the product

The website provides product information, documentation, a sample-data sandbox, and verified release downloads. Operational work happens in Axiom Agent. Browser pages used during identity-provider approval are part of desktop authentication and are not a separate web application.

00 · Before you begin

Prerequisites

  • A supported macOS, Windows, or Linux system listed on the download page
  • Permission to install software on the workstation
  • HTTPS access to the configured Axiom API and any integrations you enable
  • An organization identity and connector accounts supplied by your administrator

01

Step 1 — Download and install

1

Choose a manifest-backed installer

Open Download Axiom Agent. An operating-system button is enabled only when the current public release contains a matching installer. Select the architecture that matches your device.

2

Check release and signing information

Confirm the displayed version and read the platform-specific signing or notarization status. Detached GPG signatures verify release origin, but they do not replace operating-system code signing. Follow your organization's software-installation policy.

3

Install and launch

Follow the desktop installation guide for macOS, Windows, or Linux. If the release is marked unsigned, expect the operating system to warn you; do not bypass that warning where policy forbids unsigned software.

02

Step 2 — Authenticate the desktop

1

Start browser sign-in from Axiom Agent

The app opens a short-lived pairing flow in your browser. Sign in with the organization identity your administrator configured, review the request, and approve it.

2

Return to the installed application

Axiom Agent polls the pairing status and receives a scoped desktop session after approval. A failed, expired, or rejected request remains visible and must not be reported as connected.

03

Step 3 — Configure integrations

1

Begin with an empty workspace

A fresh installation should show useful empty states. Add only the repositories, applications, environments, clients, and connectors required for the deployment workflow you intend to run.

2

Grant least-privilege access

Begin with the GitHub App and select only the repositories required for your workflow. AWS ECS delivery additionally requires a configured environment target and OIDC role. Other integrations remain unavailable until their server registration and live validation succeed.

3

Test each connector

First check whether desktop enrollment is enabled for that provider and workspace. If the app labels setup blocked, it will not request provider secrets; an administrator must complete the scoped connector-management setup. A successful status must come from a real configured integration response—sample connectors and the website sandbox are never presented as live.

04

Step 4 — Complete a deployment workflow

  1. Capture deployment intake and required operational context.
  2. Resolve readiness checks, missing permissions, and dependencies.
  3. Generate or select the versioned playbook.
  4. Collect required approvals and separation-of-duties decisions.
  5. Follow guided execution; unavailable or failed adapters remain explicit.
  6. Run validation or schedule deferred validation with an owner.
  7. Collect evidence, review audit history, and close only when exit criteria pass.

For the released AWS ECS path, approval dispatches the tenant-owned GitHub Actions workflow. Treat any unavailable adapter as a blocker rather than a synthetic success.

05 · Verify before use

Trust questions for first launch

Where does the product run?

Operational product screens run in the installed Axiom Agent application. The public site distributes and documents it.

Why did a browser open?

The browser is used to authenticate and approve a scoped desktop pairing request. It is not the production application.

What happens without credentials?

The relevant connector remains disconnected or unavailable. It must not silently return a mock success.

Can the sandbox touch production?

No. The website sandbox uses labeled fictional sample data and cannot execute production operations.

How are updates installed?

Updates are currently manual. Check the download page and release notes for a newer verified installer.

What should I do when a step fails?

Keep the failure visible, preserve its evidence, correct the dependency or permission, and retry only the affected step.

Next steps

Still blocked?

Include the failed step and error. Never send a password, token, or cloud secret.

Open support request