Function devCommand

packages/cli/src/commands/dev.ts:79–192

(path: string, anyOptions: any)

type ServerEndpoint = TunnelEndpoint | ResolvedEndpoint;

export async function devCommand(path: string, anyOptions: any) {
  telemetryClient.dev.started(path, anyOptions);

  const result = DevCommandOptionsSchema.safeParse(anyOptions);
  if (!result.success) {
    logger.error(result.error.message);
    telemetryClient.dev.failed("invalid_options", anyOptions, result.error);
    return;
  }
  const options = result.data;

  const resolvedPath = resolvePath(path);
  runtime = await getJsRuntime(resolvedPath, logger);
  //check for outdated packages, don't immediately await this
  const checkForOutdatedPackagesPromise = runtime.checkForOutdatedPackages();

  // Read from package.json to get the endpointId
  const endpointId = await getEndpointId(runtime, options.clientId);
  if (!endpointId) {
    logger.error(
      "You must run the `init` command first to setup the project – you are missing \n'trigger.dev': { 'endpointId': 'your-client-id' } from your package.json file, or pass in the --client-id option to this command"
    );
    telemetryClient.dev.failed("missing_endpoint_id", options);
    return;
  }
  logger.success(`✔️ [trigger.dev] Detected TriggerClient id: ${endpointId}`);

  //resolve the options using the detected framework (use default if there isn't a matching framework)
  const packageManager = await runtime.getUserPackageManager();
  const framework = await runtime.getFramework();
  const resolvedOptions = await resolveOptions(framework, resolvedPath, options);

  // Read from .env.local or .env to get the TRIGGER_API_KEY and TRIGGER_API_URL
  const apiDetails = await getTriggerApiDetails(resolvedPath, resolvedOptions.envFile);
  if (!apiDetails) {
    telemetryClient.dev.failed("missing_api_key", resolvedOptions);
    return;
  }
  const { apiUrl, apiKey, apiKeySource } = apiDetails;
  logger.success(`✔️ [trigger.dev] Found API Key in ${apiKeySource}`);

  //verify that the endpoint can be reached
  const verifiedEndpoint = await verifyEndpoint(resolvedOptions, endpointId, apiKey, framework);
  if (!verifiedEndpoint) {
    logger.error(
      `✖ [trigger.dev] Your endpoint couldn't be verified. Make sure your app is running and try again. ${resolvedOptions.handlerPath}`
    );
    logger.info(
      `  [trigger.dev] You can use -H to specify a hostname, or -p to specify a port, or -s to specify https, or -t to specify the tunnel-url pointing to the local dev server.`
    );
    telemetryClient.dev.failed("no_server_found", resolvedOptions);
    return;
  }

  telemetryClient.dev.serverRunning(path, resolvedOptions);

  // Setup tunnel
  const endpointUrl = await resolveEndpointUrl(apiUrl, apiKey, verifiedEndpoint);