lowdefy/dist/program.js

Lowdefy CLI

/*
  Copyright 2020-2026 Lowdefy, Inc

  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.
  You may obtain a copy of the License at

      http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
*/ import { createRequire } from 'module';
import { Command, Option } from 'commander';
import build from './commands/build/build.js';
import dev from './commands/dev/dev.js';
import init from './commands/init/init.js';
import initDocker from './commands/init-docker/initDocker.js';
import initVercel from './commands/init-vercel/initVercel.js';
import start from './commands/start/start.js';
import upgrade from './commands/upgrade/upgrade.js';
import runCommand from './utils/runCommand.js';
const require = createRequire(import.meta.url);
const packageJson = require('../package.json');
const { description, version: cliVersion } = packageJson;
const program = new Command();
program.name('lowdefy').description(description).version(cliVersion, '-v, --version');
const options = {
    configDirectory: new Option('--config-directory <config-directory>', 'Change config directory. Default is the current working directory.').env('LOWDEFY_DIRECTORY_CONFIG'),
    devDirectory: new Option('--dev-directory <dev-directory>', 'Change the development server directory. Default is "<config-directory>/.lowdefy/dev".').env('LOWDEFY_DIRECTORY_DEV'),
    disableTelemetry: new Option('--disable-telemetry', 'Disable telemetry.').env('LOWDEFY_DISABLE_TELEMETRY'),
    logLevel: new Option('--log-level <level>', 'The minimum severity of logs to show in the CLI output.').choices([
        'error',
        'warn',
        'info',
        'debug'
    ]).default('info').env('LOWDEFY_LOG_LEVEL'),
    port: new Option('--port <port>', 'Change the port the development server is hosted at. Default is 3000.').env('PORT'),
    refResolver: new Option('--ref-resolver <ref-resolver-function-path>', 'Path to a JavaScript file containing a _ref resolver function to be used as the app default _ref resolver.'),
    serverDirectory: new Option('--server-directory <server-directory>', 'Change the server directory. Default is "<config-directory>/.lowdefy/server".').env('LOWDEFY_DIRECTORY_SERVER'),
    watch: new Option('--watch <paths...>', 'A list of paths to files or directories that should be watched for changes. Globs are supported. Specify each path to watch separated by spaces.'),
    watchIgnore: new Option('--watch-ignore <paths...>', 'A list of paths to files or directories that should be ignored by the file watcher. Globs are supported. Specify each path to watch separated by spaces.')
};
program.command('build').description('Build a Lowdefy production app.').usage('[options]').addOption(options.configDirectory).addOption(options.disableTelemetry).addOption(options.logLevel).option('--no-next-build', 'Do not build the Next.js server.').addOption(options.refResolver).addOption(new Option('--server <server>', 'Server package variant. Use "e2e" for @lowdefy/server-e2e.').choices([
    'e2e'
])).addOption(options.serverDirectory).action(runCommand({
    cliVersion,
    handler: build
}));
program.command('dev').description('Start a Lowdefy development server.').usage('[options]').addOption(options.configDirectory).addOption(options.devDirectory).addOption(options.disableTelemetry).addOption(options.logLevel).option('--no-open', 'Do not open a new tab in the default browser.').addOption(options.port).addOption(options.refResolver).addOption(options.watch).addOption(options.watchIgnore).action(runCommand({
    cliVersion,
    handler: dev
}));
program.command('init').description('Initialize a Lowdefy project.').usage('[options]').addOption(options.disableTelemetry).addOption(options.logLevel).action(runCommand({
    cliVersion,
    handler: init
}));
program.command('init-docker').description('Initialize Dockerfile.').usage('[options]').addOption(options.configDirectory).addOption(options.disableTelemetry).addOption(options.logLevel).action(runCommand({
    cliVersion,
    handler: initDocker
}));
program.command('init-vercel').description('Initialize Vercel deployment installation scripts.').usage('[options]').addOption(options.configDirectory).addOption(options.disableTelemetry).addOption(options.logLevel).action(runCommand({
    cliVersion,
    handler: initVercel
}));
program.command('start').description('Start a Lowdefy production app.').usage('[options]').addOption(options.configDirectory).addOption(options.disableTelemetry).addOption(options.logLevel).addOption(options.port).addOption(options.serverDirectory).action(runCommand({
    cliVersion,
    handler: start
}));
program.command('upgrade').description('Upgrade a Lowdefy app to a newer version, applying codemods.').usage('[options]').addOption(options.configDirectory).addOption(options.disableTelemetry).addOption(options.logLevel).addOption(new Option('--to <version>', 'Target version. Default: latest stable.')).addOption(new Option('--plan', 'Show upgrade plan without executing.')).addOption(new Option('--resume', 'Resume a previously interrupted upgrade.')).action(runCommand({
    cliVersion,
    handler: upgrade
}));
export default program;