Client SDKs

[ AxiomCore · Documentation ]

Client SDKs

Find every published AxiomCore client SDK and learn how axiom pull generates a typed client for your existing frontend.

A client SDK lets an existing browser, React or Flutter app call an AxiomCore backend through its .axiom contract. axiom pull copies the contract into your project and generates typed client code. The SDK's runtime then builds, sends and validates every request against that contract.

From contract to API call through a client SDK
From contract to API call through a client SDK
Diagram source
flowchart LR
  A[.axiom contract] --> B[axiom pull]
  B --> C[Generated client code]
  B --> D[Contract copy in your app]
  C --> E[Your app]
  E --> F[SDK runtime]
  D --> F
  F -->|validated request| G[Your backend API]
  G -->|checked response| F

Published SDKs

PackageEcosystemInstallVersionStatus
atmx-webnpmnpm install atmx-web@0.147.50.147.5Available
atmx-reactnpmnpm install atmx-react@0.147.40.147.4Alpha
atmx-cli (generator for both npm SDKs)npmnpm install --save-dev atmx-cli@0.146.70.146.7Follows the SDK it generates for
axiom_flutterpub.devflutter pub add axiom_flutter:^0.147.50.147.5Alpha
axiom_flutter_generatorpub.devflutter pub add dev:axiom_flutter_generator:^0.146.60.146.6Alpha
Swift packageSource onlyNot publishedNoneExperimental

atmx-react depends on atmx-web ^0.147.5 and needs react and react-dom 18 or 19. For Flutter, axiom pull adds both pub.dev packages to pubspec.yaml when they are missing.

Generate a client

Terminal (in your frontend project)
axiom pull ../backend/backend.axiom --framework atmx-web --name tasks --out src/generated
--frameworkDefault --outFiles written
atmx-websrc/generatedpublic/<name>.axiom, sdk.ts, models.ts
atmx-reactsrc/generatedThe same files, with React query definitions and hooks
flutterlib/axiom_generatedassets/axiom/<name>.axiom (registered in pubspec.yaml), axiom_sdk.dart, models.dart
dartlib/axiom_generatedAccepted by the CLI; it does not add packages or copy the contract asset, and these guides do not cover it

What pull does, in order:

  1. Picks the framework: --framework, else the framework key in AxiomDeps.toml, else detection, which you confirm. A pubspec.yaml that depends on Flutter gives flutter, any other pubspec.yaml gives dart, a package.json listing react or atmx-react gives atmx-react, and any other package.json gives atmx-web.
  2. Resolves the source: a local .axiom file, an AxiomDeps.toml or JSON config, an AxiomCore URL, or organization/project[/version], given positionally or with --contract (not both). With no source it re-pulls every contract in AxiomDeps.toml. Private projects need axiom login; a reference without a version follows the release promoted to latest.
  3. Fetches everything first into ~/.axiom/contracts/<name>/, so a failed download leaves AxiomDeps.toml untouched.
  4. Records the dependency: framework, plus a [contracts.<name>] table with source, optional version, and the Cloud signature and public_key when the release has them (public verification material, not credentials).
  5. Generates code with the framework's generator.

Pass --framework, --name and --out in scripts; otherwise pull prompts for the name and output directory. Commit AxiomDeps.toml with the generated files and treat generated files as read-only.

The generated backend URL is http://localhost:8080 (web and React) or http://localhost:8000 (Flutter) unless the contract's table in AxiomDeps.toml sets base_url before you pull. You can also override it at startup.

Install atmx-cli before pulling for web or React

CLI 0.149.1 runs the project's own node_modules/.bin/atmx when present. Otherwise it runs npx atmx-cli@0.149.1, which is not published, and the pull fails with npm ETARGET. Install atmx-cli@0.146.7 as a dev dependency first.

What the runtime does in your app

The runtime is Rust code compiled to Wasm for the browser and to a native library for Flutter. For each call it:

  • loads the contract and verifies its signature when one is configured;
  • resolves the endpoint and places arguments in the path, query, headers or body as the contract declares;
  • applies the endpoint's cache policy and shares identical in-flight queries;
  • attaches credentials you supplied, held in memory only;
  • validates and decodes the response, or returns a structured error with stage, category, code, message and retryability.

See The contract runtime for the request lifecycle and Runtime errors for error codes.

Next steps

AI coding agents

Give an AI coding agent current AxiomCore docs, exact tool versions, a small task and checks it can run.

Web (atmx-web)

Install atmx-web, generate a browser client with axiom pull, start the Wasm runtime and make a typed contract call.

On this page

Published SDKsGenerate a clientWhat the runtime does in your appNext steps