Reference

[ AxiomCore · Documentation ]

Glossary

Definitions of the AxiomCore terms a newcomer meets, from contracts and artifacts to UI hosts, Inspector facts, and Cloud releases.

Each entry defines one AxiomCore term in one or two sentences. Status labels (Available, Alpha, Experimental, Coming soon) are defined in Support and availability.

How the main AxiomCore terms connect
How the main AxiomCore terms connect
Diagram source
flowchart LR
  SRC[".acore source and AxiomDeps.toml"] --> BUILD["axiom build"]
  EXT["Extractor: FastAPI or Go"] --> BUILD
  BUILD --> AX[".axiom contract"]
  AX --> SERVE["Axiom server: axiom serve"]
  AX --> REL["Release in a Cloud project"]
  REL --> PULL["axiom pull"]
  PULL --> CLIENT["Generated client and runtime"]
  UISRC["Acore UI source"] --> UIBUILD["axiom ui build"]
  UIBUILD --> APP[".axiomapp"]
  APP --> HOST["UI host"]

Read the diagram left to right: you write .acore source (or extract it from an existing service), build it into an .axiom contract, then serve it locally, release it to Axiom Cloud, or pull it into a generated client. Acore UI source builds into an .axiomapp that a UI host runs.

Platform and products

TermMeaning
AxiomCoreThe contract platform: the Acore language, the Axiom CLI, build and package tooling, runtimes and client SDKs, UI tooling, tests, mocks, security analysis, and Cloud services.
AcoreThe declarative, contract-oriented language you write in .acore files. It has its own parser, evaluator, standard library, diagnostics, and language server.
Axiom CLIThe axiom command-line tool for local and connected workflows.
Acore language serverThe editor server, run as axiom lsp or the standalone acore-lsp. It works offline.
PlaygroundThe browser playground at playground.axiomcore.dev, where you can edit Acore source and preview the result.
Axiom CloudThe hosted service for projects, releases, channels, environments, mocks, tests, and runtime evidence. Alpha.
Axiom Cloud DashboardThe web control plane for accounts, projects, releases, and related Cloud workflows. Alpha.
Axiom StudioComing soon A planned visual, collaborative workspace for building software on AxiomCore. It is not installable today.
AcodeComing soon A planned contract-aware IDE. The existing language server and editor extensions are not the Acode product.
Axiom MarketplaceComing soon A planned catalog for browsing and installing Axiom packages. The package format exists; a supported marketplace workflow does not.

Source and files

TermMeaning
.acoreEditable Acore source. It is authoring input, not a locked distribution format.
AxiomDeps.tomlThe manifest beside your source. Its type (for example backend, frontend, or database) selects how the files in that directory are compiled; it also lists targets and dependencies.
DeclarationA named, typed statement in Acore source, such as project, model, endpoint, or action. Declarations describe the contract; they do not execute handlers during evaluation.
VariantA named selection of endpoints and models, such as default. A variant filters what goes into a build; it is not a runtime feature flag.
AnnotationMetadata written as @name { ... } before a member, such as @deprecated { replacement = "newName" }.

Contracts and artifacts

TermMeaning
ContractA typed, versionable description of a software boundary. Depending on its type it can include operations, data, behavior, policy, domain, UI, package, and release metadata.
ArtifactA built, non-source file with its own manifest and verification rules. .axiom and .axiomapp are artifacts.
.axiomA canonical contract or package artifact. Package kinds are service, theme, component library, database schema, extension, and application policy.
.axiomappA built Acore UI application artifact for one or more targets (web, iOS, Android). Alpha.
PackageA typed .axiom artifact that other projects depend on, such as a theme or component library. Alpha.
Lock (artifact lock)A committed file that records the exact dependency artifacts selected for a build, with integrity data, so the build is deterministic. The default UI contract lock is .axiom/axiom.ui.lock.json.
SignatureProof that exact artifact bytes came from a project's signing key. It does not prove the contract is correct, secure, or compatible.
Semantic diffA comparison that classifies what a contract change means and its compatibility impact, rather than listing changed bytes or lines. Run it with axiom diff --format semantic.
Server planA private companion file built beside a backend artifact (for example backend.server.json next to backend.axiom) that tells the Axiom server how to run the artifact's actions.

Backend

TermMeaning
ModelA typed data shape, such as model Task { id: String }.
EndpointA public HTTP or WebSocket operation with a method, path, inputs, response type, and errors.
ActionA unit of managed backend logic. Its kind is query, command, or stream.
ResourceA provider-backed dependency, such as a database table, with typed operations an action can call.
FailureA declared, typed error case with a payload and an HTTP status. An endpoint chooses which payload fields each audience sees.
ProjectionAn allowlist of fields from a domain entity that an endpoint may return to an audience.
GuardA requirement an action checks before it runs, such as an authenticated caller.
ExtractorAn adapter that reads an existing service and produces contract input. FastAPI extraction is Available; Go extraction is Alpha.
Axiom serverThe local server the CLI starts with axiom serve or axiom run to execute a contract's actions for real. It never falls back to mocks or Cloud.
Deployment fileA reviewed deployment.json that supplies the providers, credentials, and grants a backend needs for real serving.
Domain modelOptional business semantics added to a contract: entities, relationships, invariants, and projections.

Frontend and clients

TermMeaning
RuntimeThe library that loads a built contract and performs requests, validation, caching, and decoding on the client. Features and parity vary by target.
ATMXThe web runtime family: atmx-web (vanilla web, Available), atmx-react (Alpha), and the atmx-cli client generator. It includes a JavaScript layer and a WebAssembly engine.
Generated clientTyped client code that axiom pull writes for a framework (for example atmx-web or Flutter) from a contract.
Acore UIThe declarative UI profile of Acore and its build pipeline. Alpha. It is not Axiom Studio.
UI hostThe signed host application that runs Acore UI for one target: a browser, the Android Emulator, or the iOS Simulator. Install it with axiom ui host install.
TargetThe platform a build or host is for, such as web, ios, or android.

Testing, mocks and security

TermMeaning
Contract testA suite declared in the contract (testConfig) that axiom test runs against a base URL.
MockDeclared, deterministic responses for an endpoint, used in development and tests. Mock behavior is not proof of production behavior.
Server simulationRunning the real server boundary with simulated business execution (axiom serve --mock or axiom mock --profile server).
ScenarioA scripted development run against exact compiled artifacts, checked with axiom scenario. Experimental.
Security ModeOptional security(...) declarations that the compiler checks and signs into the contract. audit reports findings; strict blocks builds with error findings.
AXSEC findingA security rule result with a stable ID such as AXSEC-001. See Security rules.
ExtensionSandboxed code compiled to WebAssembly and called through a typed interface with signed permissions. Experimental.

Inspector

TermMeaning
Axiom InspectorThe CLI commands and secure local dashboard that build a queryable model of an Axiom application. Alpha. It shows declared, resolved, observed, and changed evidence, and never treats probabilistic output as authoritative.
FactA versioned statement in Inspector, such as a state declaration, operation, extension export, permission, target, or runtime event. A fact has a stable identity and points to its supporting evidence.
RelationshipA typed, directed edge between facts, such as calls, reads, writes, imports, authorizes, renders, or observed-in. Relationships power trace, lineage, reachability, why, and impact queries.
Graph revisionThe content-derived identity of one Inspector evidence graph. Keep it with query, runtime, diff, and agent results so an answer is never read against different source or lock state.

Cloud and delivery

TermMeaning
WorkspaceA group of members and projects in Axiom Cloud.
Cloud projectThe Cloud home for one contract's releases, signing-key history, channels, mocks, environments, tests, and evidence. A local directory is linked to it with axiom project link.
ReleaseAn immutable project and version pair in Axiom Cloud. Retrying the same bytes is allowed; different bytes need a new version.
ChannelA mutable pointer to an eligible release. latest is the current channel; activation and rollback move the pointer without editing artifacts.
EnvironmentA separate scope for application data, users, sessions, configuration, and secrets, such as development, staging, or production.
SandboxA managed Cloud environment that runs a verified artifact with synthetic mock data. It is not a production data plane.

Next steps