CLI Reference

[CLI REFERENCE]

13 groups · 10 subcommands. Invoke via bun run axis -- <args> so Bun forwards flags, or make axis ARGS="…". After bun link from packages/cli, axis works as a local bin. Install, doctor, setup, secrets, deploy, and health for Cloudflare® Worker pynescript-axis.

@hoox-sh/axis-cli • product v2.0.1 • CLI package version is independent · bin axis

Installation guide
Quick Start

Local UI instead of deploy: bun run dev

Global options (apply to every command)
--jsonMachine-parseable JSON output
--quietMinimal output
-y, --yesSkip confirmation prompts
-h, --helpShow help
[]
01

Onboard

3 groups
[ Onboard ]01

axis install

bun install at the monorepo root plus worker/ and the CLI. App + Worker + CLI deps in one shot.

Wrapper: bun run axis:install. Env: AXIS_ROOT, AXIS_WORKER_URL, CLOUDFLARE_API_TOKEN, AXIS_CLI_SRC=1.

[ Onboard ]02

axis doctor

Toolchain, wrangler.toml, Cloudflare® auth, and optional live /health.

Wrapper: bun run axis:doctor. For flags via bun: bun run axis -- doctor --remote.

Flags — check to add to commands
[ Onboard ]03

axis setup

Bootstrap: install → ensure wrangler.toml → local Cloudflare® D1. Combined flags can provision OAuth and remote Cloudflare® D1 in one pass.

When using bun run axis setup -- --flag, keep the -- so Bun forwards flags.

Flags — check to add to commands
02

Develop

1 group
[ Develop ]01

axis dev

Vite product UI on :3000. Pair with Flask Pro API (make -C ../pynescript run) on :5002 for the server engine.

Also: bun run dev (Vite) · bun run desktop:dev (Tauri).

03

Ship

1 group
[ Ship ]01

axis deploy

Deploy Cloudflare® Worker pynescript-axis, optional Cloudflare® Pages, or both. Project id is frozen — do not rename.

Wrapper: bun run axis:deploy → axis deploy worker.

04

Configure

4 groups
[ Configure ]01

axis setup worker

Copy wrangler.toml.example → wrangler.toml if missing.

[ Configure ]02

axis setup d1

Apply worker/schemas/scripts.sql to Cloudflare® D1 (database name pynescript).

Flags — check to add to commands
[ Configure ]03

axis setup oauth

Set the public OAuth App id in [vars] (or --secret). Device Flow must be enabled on GitHub.

Flags — check to add to commands
[ Configure ]04

axis secret

Wrangler secrets for the Worker: ADMIN_TOKEN, EXTERNAL_BACKEND, and related values. Prefer secrets over committed vars.

When using bun run axis -- secret put NAME, keep the -- so Bun forwards the subcommand.

05

Verify

2 groups
[ Verify ]01

axis health

Probe /health and optionally start the GitHub device flow.

Wrapper: bun run axis:health -- --oauth.

Flags — check to add to commands
[ Verify ]02

axis whoami

Print the authenticated Cloudflare® account.

06

Meta

2 groups
[ Meta ]01

axis --help

Print the AXIS CLI command surface.

After bun link from packages/cli, axis --help works as a local bin.

[ Meta ]02

make axis

Makefile pass-through to packages/cli/bin/axis.js. Fixed wrappers: axis-install, axis-doctor, axis-setup, axis-deploy, axis-health.

Env: AXIS_ROOT, AXIS_WORKER_URL, CLOUDFLARE_API_TOKEN, AXIS_CLI_SRC=1.

Command Groups13
Categories6
Subcommands10
AXIS version2.0.1
axis install axis deploy axis health