Skip to content

Getting Started

Jump to bottom
Manit Arora edited this page Oct 21, 2026 · 4 revisions

Getting Started

This page walks through installing AXIOM, creating a project workspace, and opening the local Control Center. The examples target v0.3.0-beta.4 and may evolve as the beta changes.

1. Choose an installation path

Python / PyPI

The distribution name is axiom-all; the executable is axiom. Beta versions may require --pre:

python -m pip install --upgrade --pre axiom-all
axiom version

A virtual environment is recommended when working across multiple Python projects.

Debian, Ubuntu, and Linux Mint (amd64)

curl -fsSLo /tmp/axiom-archive-keyring.gpg https://netcore-technologies.github.io/AXIOM-AI/apt/axiom-archive-keyring.gpg
sudo install -Dm0644 /tmp/axiom-archive-keyring.gpg /usr/share/keyrings/axiom-archive-keyring.gpg
echo 'deb [arch=amd64 signed-by=/usr/share/keyrings/axiom-archive-keyring.gpg] https://netcore-technologies.github.io/AXIOM-AI/apt stable main' | sudo tee /etc/apt/sources.list.d/axiom.list
sudo apt update
sudo apt install axiom-ai

This APT package currently targets 64-bit Intel/AMD (amd64).

macOS and Linux installer

curl -fsSL https://raw.githubusercontent.com/NetCore-Technologies/AXIOM-AI/main/installers/install.sh | bash
axiom version

The installer places the command at ~/.local/bin/axiom. Ensure that directory is included in PATH. The exact binary packages available for each release are listed on the Releases page.

Windows PowerShell

irm https://raw.githubusercontent.com/NetCore-Technologies/AXIOM-AI/main/installers/install.ps1 | iex
axiom version

The installer targets %LOCALAPPDATA%\AXIOM; reopen PowerShell if the PATH change is not visible.

Beta download check: v0.3.0-beta.4 is a prerelease. Check the release page and Actions workflow before relying on platform-specific packaged assets.

2. Verify the CLI

axiom version
axiom --help
axiom guide
axiom summary

guide explains the current directory and suggests commands. summary is a read-only snapshot of the workspace and visible environment.

3. Create a workspace

axiom init my-ai
cd my-ai
axiom project validate
axiom config validate
axiom system info

The project configuration is stored in axiom.yaml; AXIOM's local model registry lives in .axiom.

4. Run diagnostics

axiom doctor
axiom doctor --json

The diagnostic checks report workspace discovery, configuration parsing, filesystem access, disk space, Python compatibility, and required imports. Checks are read-only; AXIOM does not automatically repair the workspace.

For more detail, read Workspace Diagnostics and Support Bundles.

5. Open the Control Center

axiom gui

To print the local URL without opening a browser automatically:

axiom gui --no-open

The Control Center is served locally by AXIOM. The standalone HTTP daemon is available separately:

axiom daemon --host 127.0.0.1 --port 0

The default daemon bind is loopback-only. Explicitly enabling network access with --allow-network changes the exposure boundary; do not do so casually.

6. Make a first plan

axiom train plan 7 --method qlora

This estimates a starting configuration. It does not download model weights or start training. See Workflow Design and Execution Boundaries for the difference between planning and execution.

Where to go next

AXIOM AI source repository · Issues · MIT license

Clone this wiki locally