homey/bin/cmds/app/run.mjs

Command-line interface and type declarations for Homey Apps

import Log from '../../../lib/Log.js';
import AppFactory from '../../../lib/AppFactory.js';

export const desc = 'Run a Homey App in development mode';
export const builder = (yargs) => {
  return yargs
    .option('clean', {
      alias: 'c',
      type: 'boolean',
      default: false,
      desc: 'Delete all userdata, paired devices etc. before running the app.',
    })
    .option('remote', {
      alias: 'r',
      type: 'boolean',
      default: false,
      desc: 'Upload the app to Homey Pro and run remotely, instead of a Docker container on this machine. Defaults to true for Homey Pro 2019 and earlier.',
    })
    .option('skip-build', {
      alias: 's',
      type: 'boolean',
      default: false,
      desc: 'Skip the automatic build step.',
    })
    .option('link-modules', {
      alias: 'l',
      type: 'string',
      default: '',
      desc: 'Provide a comma-separated path to local Node.js modules to link. Only works when running the app inside Docker.',
    })
    .option('network', {
      alias: 'n',
      default: 'bridge',
      type: 'string',
      description:
        'Docker network mode. Must match name from `docker network ls`. Only works when running the app inside Docker.',
    })
    .option('docker-socket-path', {
      default: undefined,
      type: 'string',
      description: 'Path to the Docker socket.',
    })
    .option('find-links', {
      default: undefined,
      type: 'string',
      desc: 'Additional location to search for candidate Python package distributions',
    });
};
export const handler = async (yargs) => {
  try {
    const app = AppFactory.getAppInstance(yargs.path);
    await app.run({
      clean: yargs.clean,
      remote: yargs.remote,
      skipBuild: yargs.skipBuild,
      linkModules: yargs.linkModules,
      network: yargs.network,
      dockerSocketPath: yargs.dockerSocketPath,
      findLinks: yargs.findLinks,
    });
  } catch (err) {
    if (err instanceof Error && err.stack) {
      Log.error(err.stack);
    } else {
      Log.error(err);
    }
    process.exit(1);
  }
};