Skip to content

init

Creates a starter deploy.ts or deploy.js file, then installs @catapultjs/deploy as a dev dependency with the detected package manager unless you pass --skip-install.

Usage

bash
npx @catapultjs/deploy init

Options

OptionDescription
--skip-installCreate the config file without installing @catapultjs/deploy

What it does

  1. Prompts you to choose TypeScript or JavaScript.
  2. Creates deploy.ts or deploy.js in the current directory.
  3. Installs @catapultjs/deploy with the detected package manager, unless you use --skip-install.

Examples

bash
npx @catapultjs/deploy init
npx @catapultjs/deploy init --skip-install

This command does not require a deploy config file.

Output example