Skip to main content

Recipes

quik config:print --format json

Prints getConfig().all() as pretty JSON by default, or compact JSON with --format json.

Generate typed config files from defaults​

quik config:generate --out-dir src/config --merge

Generates TypeScript config files from the currently loaded defaults. --merge merges into existing files instead of overwriting them.

Generate an application key​

quik crypto:app-key:generate
quik crypto:app-key:generate --env-file .env.production

Writes a random QUIK_APP_KEY into the target env file (.env by default), creating the file if needed.

Scaffold a module​

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

module:create accepts a name positional argument plus --out-dir, --folder-name, --merge-models-and-entities, --no-database, --no-services, and --no-routes options to control which scaffolded files are generated.

Execute a command programmatically​

import { CommandStore } from '@quik/cli';

await CommandStore.execute('config:print', { format: 'json' });

Useful in tests or scripts that need to invoke a command without going through yargs argument parsing.