@codapult/create

Scaffold a new Codapult SaaS project.

Usage

# npm
npx @codapult/create my-app

# pnpm
pnpm create @codapult my-app

# yarn
yarn create @codapult my-app

# bun
bunx @codapult/create my-app

The CLI will:

1. Download the latest Codapult template from GitHub
2. Run the interactive setup wizard (choose auth, payments, storage, modules)
3. Install dependencies

Development

pnpm install
pnpm run build    # compile TypeScript
pnpm test         # run unit tests
pnpm lint         # lint
pnpm typecheck    # type-check without emitting

Test locally after building:

node dist/index.js my-test-app

Releasing

Releases are managed with release-it. The workflow:

1. Run the release command on the main branch:

pnpm run release          # interactive — prompts for version bump type
pnpm run release -- patch # non-interactive patch bump (0.1.0 → 0.1.1)
pnpm run release -- minor # minor bump (0.1.0 → 0.2.0)
pnpm run release -- major # major bump (0.1.0 → 1.0.0)

2. release-it will automatically:

   • Run pre-release checks (lint, typecheck, test)
   • Bump the version in package.json
   • Update CHANGELOG.md from Conventional Commits
   • Commit the changes (chore: release v<version>)
   • Create a Git tag (v<version>)
   • Push the commit and tag to origin

3. The v* tag push triggers the Publish GitHub Actions workflow, which builds and publishes the package to npm.

Dry run

Preview what a release would do without making any changes:

pnpm run release -- --dry-run

Prerequisites

• npm trusted publishing must be configured for the @codapult/create package on npmjs.com.
• Commit messages should follow Conventional Commits for meaningful changelogs (e.g. feat:, fix:, chore:).