Get started

[ AxiomCore · Documentation ]

Get started

Choose a first path into AxiomCore based on the backend, frontend or database you already have.

Pick the path that matches what you have today, get one part working, then add the others. Every path starts with installing the Axiom CLI. No Cloud account is needed for local work.

Choose a path

Choosing a first path from what you already have
Choosing a first path from what you already have
Diagram source
flowchart TD
  A{What do you have?} -->|Nothing yet| B[Build with Acore]
  A -->|A FastAPI or Go service| C[Connect an existing backend]
  A -->|A web, React or Flutter app| D[Connect an existing frontend]
  A -->|A database or schema| E[Start from a database]
PathFirst stepYou keepStart here
Build with AcoreRun an Acore UI and API on SQLite, then write your ownAuthored .acore source; the generated UI host graph stays opaqueRun your first app
Connect an existing backendExtract and build a service contract from FastAPI or GoYour Python or Go application and framework runtimeFastAPI or Go
Connect an existing frontendPull a contract and generate a client for your frameworkYour UI framework and application codeBuild your first UI
Start from a databaseWrite a schema in Acore, or bootstrap bounded input from OpenAPI or SQL DDL for reviewYour existing schema authority and runtimeCreate your first database or Existing database

To share design, API or schema content between projects, build a typed .axiom package and lock it in each consumer. See Packages.

Quickstarts

GoalGuideResult
A small full-stack appRun your first appAcore UI and API with tasks stored in SQLite
An APIBuild your first APIA running, typed endpoint
A UIBuild your first UIAn Acore web app, or a client in your existing app
DataCreate your first databaseA schema, a row and a migration history

Let the CLI suggest a path

From your application's directory, axiom doctor reports prerequisites and axiom onboard detects whether the repository is a backend, frontend or both and prints the shortest supported next step. Neither command changes files unless you ask.

Your application directory
axiom doctor
axiom onboard

In automation, pass the role explicitly:

Terminal
axiom onboard --role backend --entrypoint main.py:app --module axiom-fastapi
axiom onboard --role frontend --contract organization/project --framework atmx-web

Add --apply only when you want backend onboarding to create axiom.acore. Onboarding never releases a contract. Install the Axiom CLI describes both commands in full.

Boundaries to decide early

  • Authority. Decide whether backend code, OpenAPI, SQL or authored Acore owns each fact. Avoid two owners for one fact.
  • Audience. Choose the frontend projection before you lock a contract.
  • Runtime. Decide whether your existing UI framework or Acore UI owns each screen. Both can consume Axiom contracts, and neither requires rewriting the backend in Acore.
  • Maturity. Add an end-to-end test in your own CI for every Alpha or Experimental path. Check the support matrix before taking a local example to another target or deployment.

Next steps

Support and availability

Choose a supported AxiomCore path and check its framework, target, platform and distribution limits.

Install the Axiom CLI

Install Axiom CLI 0.149.1, check your environment with axiom doctor and axiom onboard, and add the host, extractor or editor support your path needs.

On this page

Choose a pathQuickstartsLet the CLI suggest a pathBoundaries to decide earlyNext steps