Page:
core cli Overview
Pages
Home
ai Overview
ai gemini Overview
api HowTo
api Overview
api client HowTo
api client Overview
api server HowTo
api server Overview
api server express HowTo
app HowTo
app Overview
auth HowTo
auth Overview
auth basic HowTo
auth basic Overview
auth firebase HowTo
auth firebase Overview
auth oidc Overview
auth pocketbase HowTo
auth pocketbase Overview
auth supabase HowTo
auth supabase Overview
backend HowTo
backend Overview
backend firestore Overview
backend migrations Overview
backend postgres Overview
backend restapi Overview
backend restapi recipes Overview
backend sqlite HowTo
backend sqlite Overview
cache Overview
cache redis Overview
cloudwrapper HowTo
cloudwrapper Overview
cloudwrapper firebase HowTo
cloudwrapper firebase Overview
cloudwrapper supabase HowTo
cloudwrapper supabase Overview
code Overview
code github Overview
core HowTo
core Overview
core cli HowTo
core cli Overview
gateway upstream express HowTo
gateway upstream express Overview
i18n HowTo
i18n Overview
i18n en HowTo
i18n en Overview
i18n fr HowTo
i18n fr Overview
log HowTo
log Overview
messaging HowTo
messaging Overview
messaging firebase HowTo
messaging firebase Overview
queue HowTo
queue Overview
queue amqp HowTo
queue amqp Overview
queue aws HowTo
queue aws Overview
queue gcp HowTo
queue gcp Overview
storage HowTo
storage Overview
storage firebase HowTo
storage firebase Overview
storage local Overview
storage s3 HowTo
storage s3 Overview
storage supabase HowTo
storage supabase Overview
studio Overview
testing Overview
types HowTo
types Overview
ui Overview
ui form react Overview
ui list HowTo
ui list Overview
ui list react HowTo
ui list react Overview
worker HowTo
worker Overview
No results
1
core cli Overview
GitHub Action edited this page 2026-05-21 19:42:21 +00:00
@quatrain/core-cli
The official Command Line Interface (CLI) for the Quatrain ecosystem. This CLI provides tools to scaffold projects, generate normalized bootloader configurations, and create migration files.
Installation
You can install the CLI globally via NPM or Yarn, or run it on the fly using npx or bunx.
Global Installation
npm install -g @quatrain/core-cli
# or
yarn global add @quatrain/core-cli
# or via Bun
bun add -g @quatrain/core-cli
On-the-fly Execution
npx @quatrain/core-cli <command>
# or
bunx @quatrain/core-cli <command>
Commands
core generate scaffold <project-name>
Quickly initializes a new Quatrain project.
- Creates a base directory.
- Sets up the
apps/,data/,config/,packages/, andmigrations/folders. - Generates a monorepo-ready
package.jsonutilizing Yarn workspaces. - Generates a
tsconfig.jsonpre-configured with the required path mappings.
core generate config
Starts an interactive wizard to generate a quatrain.json configuration file.
- Prompts for Backend, Auth, Queue, Storage, and Messaging adapters.
- Generates a normalized JSON configuration.
- The generated
env(...)tokens will be resolved at runtime by theAppBootloader.
core generate migration <name>
Scaffolds a new migration file.
- Creates a
migrations/directory if it does not exist. - Generates a timestamped TypeScript file (e.g.,
20260427184500_init.ts). - Provides boilerplate
up()anddown()methods.
Language Guidelines
Recommendation: All text contents (such as console logs, commit messages, and comments) within the Quatrain ecosystem must be written in International English. This ensures accessibility and maintainability for developers worldwide.
HOWTO / Usage Examples
# Example of scaffolding a new project
yarn global add @quatrain/core-cli
quatrain generate scaffold my-app
cd my-app
yarn install
Core Documentation
Foundations
Storage, Data & Cache
- backend
- backend-firestore
- backend-postgres
- backend-sqlite
- backend-migrations
- storage
- storage-firebase
- storage-s3
- storage-supabase
- storage-local
- cache
- cache-redis
Queue & Messaging
Auth & Cloud
- auth
- auth-firebase
- auth-supabase
- auth-oidc
- auth-pocketbase
- cloudwrapper
- cloudwrapper-firebase
- cloudwrapper-supabase