System Utilities

This set of utilities exposes some of Raycast's native functionality to allow deep integration into the user's setup. For example, you can use the Application APIs to check if a desktop application is installed and then provide an action to deep-link into it.

API Reference

getApplications

Returns all applications that can open the file or URL.

Signature

async function getApplications(path?: PathLike): Promise<Application[]>;

Example

import { getApplications, Application } from "@raycast/api";

// it is a lot more reliable to get an app by its bundle ID than its path
async function findApplication(bundleId: string): Application | undefined {
  const installedApplications = await getApplications();
  return installedApplications.filter((application) => application.bundleId == bundleId);
}

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

export default async function Command() {
  const installedApplications = await getApplications();
  console.log("The following applications are installed on your Mac:");
  console.log(installedApplications.map((a) => a.name).join(", "));
}

Parameters

Return

An array of Application.

getDefaultApplication

Returns the default application that the file or URL would be opened with.

Signature

Example

Parameters

Return

A Promise that resolves with the default Application that would open the file or URL. If no application was found, the promise will be rejected.

getFrontmostApplication

Returns the frontmost application.

Signature

Example

Return

A Promise that resolves with the frontmost Application. If no application was found, the promise will be rejected.

showInFinder

Shows a file or directory in the Finder.

Signature

Example

Parameters

Return

A Promise that resolves when the item is revealed in the Finder.

trash

Moves a file or directory to the Trash.

Signature

Example

Parameters

Return

A Promise that resolves when all files are moved to the trash.

open

Opens a target with the default application or specified application.

Signature

Example

Parameters

Return

A Promise that resolves when the target has been opened.

captureException

Report the provided exception to the Developer Hub. This helps in handling failures gracefully while staying informed about the occurrence of the failure.

Signature

Example

Parameters

Types

Application

An object that represents a locally installed application on the system.

It can be used to open files or folders in a specific application. Use getApplications or getDefaultApplication to get applications that can open a specific file or folder.

Properties

PathLike

Supported path types.