Setup packages CLI reference

Status: Preview

Setup packages are currently in preview. Functionality, file format, and behavior may change between releases. Not recommended for production deployments yet.

Installation

npm

npm install -g @dimescheduler/setup

npx

npx @dimescheduler/setup <command>

Commands

validate

Validate a configuration file against the schema.

dimescheduler-setup validate <file> [options]

Arguments:

• <file>: Path to .json5 or .json configuration file

Options:

• --json: Output results as JSON

Exit codes:

• 0: Valid configuration
• 1: Validation errors

Example:

dimescheduler-setup validate my-profile.json5

compile

Compile JSON5 configuration to API-ready JSON.

dimescheduler-setup compile <file> [options]

Arguments:

• <file>: Path to .json5 configuration file

Options:

• -o, --output <dir>: Output directory for compiled files
• --stdout: Output to stdout instead of file
• --skip-validation: Skip schema validation

Example:

# Compile to directory
dimescheduler-setup compile my-profile.json5 -o ./dist

# Compile to stdout
dimescheduler-setup compile my-profile.json5 --stdout

deploy

Deploy configuration to a Dime.Scheduler instance.

dimescheduler-setup deploy <file> --api-key <key> --env <env> [options]

Arguments:

• <file>: Path to configuration file

Required options:

• --api-key <key>: API key (or set DS_API_KEY environment variable)
• --env <environment>: Target environment: production, sandbox, or test

Additional options:

• --skip-validation: Skip schema validation
• --json: Output results as JSON
• --dry-run: Validate and compile only, don't deploy
• -y, --yes: Skip confirmation prompt

Exit codes:

• 0: Success (or cancelled by user)
• 1: Validation or compilation error
• 2: Deployment error

Examples:

# Deploy with confirmation
dimescheduler-setup deploy my-profile.json5 --api-key abc123 --env production

# Deploy without confirmation
dimescheduler-setup deploy my-profile.json5 --api-key abc123 --env production -y

# Using environment variable
export DS_API_KEY=abc123
dimescheduler-setup deploy my-profile.json5 --env production

# Dry run (validate and compile only)
dimescheduler-setup deploy my-profile.json5 --api-key abc123 --env sandbox --dry-run

Environment variables

Variable	Description
DS_API_KEY	API key for deployment (alternative to --api-key)