Getting Started

Not published yet

npx axiom doesn’t work yet: the CLI isn’t on npm. This page is the specification it is being built against, so commands and options may still change.

All you need is an Expo or React Native app. Run these at its root.

Initialize

npx axiom init

pnpm dlx axiom init

yarn dlx axiom init

bun x axiom init

Pick the styling tool you already use:

Terminal

◆  Which styling tool does your project use?
│  ● stylesheet
│  ○ unistyles
│  ○ nativewind
│  ○ uniwind
└

That’s the only question. init copies the theme and the headless core, fixes your tsconfig.json aliases if needed, and saves your choices in axiom.json.

Add a component

npx axiom add button

pnpm dlx axiom add button

yarn dlx axiom add button

bun x axiom add button

The button lands in components/ui/button.tsx, in the variant that matches your styling, with anything it depends on.

Use it

import { Button } from "@/components/ui/button";

export function SaveButton() {
	return <Button>Save</Button>;
}

Run your app. The button is there, and the file is yours: open it and change whatever you want.

Keep going

Add the next piece your screen needs. Whatever it relies on comes with it:

npx axiom add bottom-sheet

pnpm dlx axiom add bottom-sheet

yarn dlx axiom add bottom-sheet

bun x axiom add bottom-sheet

Primitives

Pick your next component.

Compositions

Ready-made cards, rows and app bars.

Foundations

Make the theme yours.

CLI

Every command and option, and axiom.json.

Without the CLI

Every component page shows the source for each styling variant, the internal files to copy first (such as portal or tappable) and the npm packages to install. Copy, install, import.