Skip to content

axs new

Open in ChatGPTOpen in Claude

axs new scaffolds a new project from a starter template, writes axis.json, initialises git, installs dependencies, and activates the git hooks. create is a deprecated hidden alias for one release. Starters: rest-v1, rest-v2, graphql, worker, bare; layouts: module (default) and feature (rest-v1, rest-v2, graphql, worker). Pass --composer for a composed app with an axis.json selections block instead of config/features.ts.

Terminal window
axs new my-api --template rest-v1

The full option surface is generated from the CLI itself:

Usage: axs new <projectName>
Scaffold a new Axis project
Arguments:
projectName
Options:
-t, --template <template> Starter: rest-v1 | rest-v2 | graphql | bare (prompted if omitted)
-l, --layout <layout> Directory layout: module | feature (feature: rest-v1, rest-v2, graphql, worker) (default: "module")
--skip-install Skip git init, install and husky setup
-y, --yes Skip the summary confirmation (CI / non-interactive)
--composer Scaffold a build-your-own project (composer wiring)
--api-access <mode> Composer REST/v2 access: public | authenticated | mixed
--authorizer <kind> Composer REST/v2 authorizer: cognito | iam | custom | none
--api-key Composer REST v1: require an API key (orthogonal)
--graphql-auth-mode <mode> Composer GraphQL default auth: cognito | apiKey | iam | oidc | custom
--graphql-additional-mode <mode> Composer GraphQL additional auth mode (repeatable)
--oidc-issuer <url> Composer GraphQL OIDC issuer URL
--local Use local framework folder (dev/testing — skips auth)

© 2026 Axis Tech. Powered by axis-tech.co.