This set of utilities to work with Raycast commands.

Launches another command. If the command does not exist, or if it's not enabled, an error will be thrown. If the command is part of another extension, the user will be presented with a permission alert. Use this method if your command needs to open another command based on user interaction, or when an immediate background refresh should be triggered, for example when a command needs to update an associated menu-bar command.

export async function launchCommand(options: LaunchOptions): Promise<void>;

import { launchCommand, LaunchType } from "@raycast/api";

export default async function Command() {
  await launchCommand({ name: "list", type: LaunchType.UserInitiated, context: { foo: "bar" } });
}

A Promise that resolves when the command has been launched. (Note that this does not indicate that the launched command has finished executing.)

Update the values of properties declared in the manifest of the current command. Note that currently only subtitle is supported. Pass null to clear the custom subtitle.

{% hint style="info" %} The actual manifest file is not modified, so the update applies as long as the command remains installed. {% endhint %}

export async function updateCommandMetadata(metadata: { subtitle?: string | null }): Promise<void>;

import { updateCommandMetadata } from "@raycast/api";

async function fetchUnreadNotificationCount() {
  return 10;
}

export default async function Command() {
  const count = await fetchUnreadNotificationCount();
  await updateCommandMetadata({ subtitle: `Unread Notifications: ${count}` });
}

A Promise that resolves when the command's metadata have been updated.

Represents the passed context object of programmatic command launches.

A parameter object used to decide which command should be launched and what data (arguments, context) it should receive.

The options that can be used when launching a command from the same extension.

The options that can be used when launching a command from a different extension.