Skip to main content

@quik/cli

CLI module for Quik. Provides built-in commands and a simple extension API.

Built-in Commands​

  • config:print - Print resolved configuration.
  • config:generate - Generate TypeScript config files from defaults.
  • crypto:app-key:generate - Generate QUIK_APP_KEY and update or create an env file.
  • module:create - Generate a module scaffold for projects using the framework.

Usage​

quik config:print --format pretty
quik config:generate --out-dir src/config --merge
quik crypto:app-key:generate
quik crypto:app-key:generate --env-file .env.production
quik module:create Billing --out-dir src/modules
quik module:create @billing/orders --folder-name orders
quik module:create Billing --no-database --no-services --no-routes --merge-models-and-entities

API Reference​

Generated API documentation is available in the cli API section.