Function initCommand

packages/cli/src/commands/init.ts:37–160

(options: InitCommandOptions)

type ResolvedOptions = Required<InitCommandOptions>;

export const initCommand = async (options: InitCommandOptions) => {
  telemetryClient.init.started(options);

  const resolvedPath = resolvePath(options.projectPath);

  // assuming nodejs by default
  let runtimeId: string = "nodejs";
  try {
    runtimeId = (await getJsRuntime(resolvedPath, logger)).id;
  } catch {}
  if (runtimeId !== "nodejs") {
    logger.error(
      `We currently only support automatic setup for NodeJS projects. This is a ${runtimeId} project. View our manual installation guides here: https://trigger.dev/docs/documentation/quickstarts/introduction`
    );
    telemetryClient.init.failed("not_supported_runtime", options);
    return;
  }

  await renderTitle(resolvedPath);

  if (options.triggerUrl === CLOUD_TRIGGER_URL) {
    logger.info(`✨ Initializing project in Trigger.dev Cloud`);
  } else if (typeof options.triggerUrl === "string") {
    logger.info(`✨ Initializing project using Trigger.dev at ${options.triggerUrl}`);
  } else {
    logger.info(`✨ Initializing Trigger.dev in project`);
  }

  const packageManager = await getUserPackageManager(resolvedPath);
  const framework = await getFramework(resolvedPath, packageManager);

  if (!framework) {
    logger.error(
      `We currently only support automatic setup for ${frameworkNames()} projects (we didn't detect one). View our manual installation guides for all frameworks: https://trigger.dev/docs/documentation/quickstarts/introduction`
    );
    telemetryClient.init.failed("not_supported_project", options);
    return;
  }
  logger.success(`✔ Detected ${framework.name} project`);

  const hasGitChanges = await detectGitChanges(resolvedPath);
  if (hasGitChanges) {
    // Warn the user that they have git changes
    logger.warn(
      "⚠️ You have uncommitted git changes, you may want to commit them before continuing."
    );
  }

  const isTypescriptProject = await detectTypescriptProject(resolvedPath);
  telemetryClient.init.isTypescriptProject(isTypescriptProject, options);

  const optionsAfterPrompts = await resolveOptionsWithPrompts(options, resolvedPath);
  const apiKey = optionsAfterPrompts.apiKey;

  if (!apiKey) {
    logger.error("You must provide an API key to continue.");
    telemetryClient.init.failed("no_api_key", optionsAfterPrompts);
    return;