antd-admin/packages/create/README.md

init-antd-admin

Scaffold a standalone Antd Admin style app from official monorepo examples (apps/basic, apps/with-lingui, …). Templates are fetched from GitHub at install time (similar idea to create-turbo).

Requirements: Node.js ≥ 20.

Usage

npx init-antd-admin@latest
pnpm dlx init-antd-admin@latest
yarn dlx init-antd-admin@latest
bunx init-antd-admin@latest

Non-interactive example:

pnpm dlx init-antd-admin@latest my-app --example basic -m pnpm

Skip dependency install (faster smoke test):

pnpm dlx init-antd-admin@latest my-app --example basic --skip-install

CLI options

Option	Description
[project-directory]	Target folder (relative path or .; empty dirs only)
`-e, --example <name	url>`
--example-path <path>	Extra path inside the repo when using a URL
-m, --package-manager	npm
--skip-install	Do not run install after scaffold
--skip-transforms	Skip rewrites (e.g. package.json name)
--no-git	Do not run git init
-v, --version	Print CLI version
-h, --help	Print help

Run init-antd-admin --help for the full help text.

Environment

Variable	Purpose
CREATE_ANTD_ADMIN_REPO	Override owner/name (default: zuiidea/antd-admin)
CREATE_ANTD_ADMIN_REF	Override Git ref (branch, tag, or SHA). Default is v<cliVersion> from this package’s package.json; falls back to main if the version file cannot be read.

Built-in examples

At publish time, apps/* is scanned (excluding apps/docs) and written to dist/examples.json. Short names passed to --example must appear in that list.

Develop in this monorepo

From repository root:

pnpm install
cd packages/create
pnpm run build
pnpm test
node dist/cli.js --help

Design and implementation notes live under docs/specs/ in the monorepo (e.g. 2026-04-14-create-antd-admin-design.md).

Publish (maintainers)

CI workflow: .github/workflows/publish-init-antd-admin.yml in the monorepo (open on GitHub from the default branch).

1. Add repository secret **NPM_TOKEN** (npm automation or granular token with publish permission for init-antd-admin).
2. Bump **version** in this directory’s package.json, commit, then either:

• Actions → “Publish init-antd-admin” → Run workflow, or
• Push tag **init-antd-admin-v<version>** (e.g. init-antd-admin-v1.0.3 must match package.json version 1.0.3).

3. Push a matching **v<version>** tag on the monorepo (e.g. v1.0.3) if users rely on the default template ref v${version} from the CLI.

If provenance publish fails from your machine, publish from CI (this workflow passes --provenance) or see npm provenance docs.

License

MIT (same as the parent repository).