open-finder-dialog

Open a finder dialog window (finder prompt) programmatically. Only works on MacOS.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save open-finder-dialog

Usage

Heads up!: release v1.0.0 introduced breaking changes. Please see the release history for details.

import { openFinderDialog } from 'open-finder-dialog';
// or
import openFinderDialog from 'open-finder-dialog';

// Open the dialog in the current working directory
const { files, canceled } = await openFinderDialog();
console.log('Selected files:', files);
// You can use the `canceled` property to determine if the user
// canceled the dialog intentionally, so you can customize messaging
// or logic accordingly.

API

Signature:

export const openFinderDialog = async (
  initialDirectory?: string,
  options?: {
    filters?: string[];
    limit?: number;
    terminal?: string;
  }
): Promise<{ files: string[]; canceled: boolean; }>;

Returns

A promise that resolves to an object:

files: an array of absolute POSIX file paths (as strings) that the user selected.
canceled: true if the user canceled the dialog, otherwise false.

Example usage

// Open the dialog in the current working directory
const { files, canceled } = await openFinderDialog();
console.log('Selected files:', files);

if (canceled) {
  console.log('User canceled the dialog');
}

Example with custom options:

const { files } = await openFinderDialog('/Users/alex/Pictures', {
  limit: 2,
  filters: ['jpeg', 'png', 'json'],
  terminal: 'iTerm'
});

console.log('Selected files:', files);

Opens a Finder dialog to select one or more files and returns the paths of selected files. Handles single and multiple selections, ensures correct focus return to the terminal, and uses macOS native dialogs.

Params

initialDirectory (optional)

The initial directory where the dialog should open. Defaults to the current working directory.

const output = await openFinderDialog('/some/directory');

options (optional)

Options for the file dialog:

filters: string[] — File UTI types or extensions to filter (e.g. [public.jpeg, public.png] or file extensions depending on macOS support).
limit: number — Maximum number of files that can be selected (minimum 1, default: 100).
terminal: string — Optionally specify your terminal app name, so focus returns to it after closing the dialog. If not set, detect-terminal is used.

const output = await openFinderDialog(process.cwd(), {
  filters: ['public.jpeg'],
  limit: 1,
  terminal: 'iTerm'
});

Notes about "limit"

If you set a limit other than 1, finder will not (cannot) prevent over-selection in the dialog. Meaning the user will potentially be able to select more than limit files. This is a limitation of the macOS Finder dialog, so the limit is enforced programmatically (by the applescript) after selection.

AFAIK this is the only way it can be done, but I would love to have a better solution if someone wants to do a PR or open an issue to discuss.

History

v0.0.1

Initial release

v0.0.2

Added support for specifying the terminal app.

v1.0.0

BREAKING CHANGE: Functions now return an object with files and canceled properties, instead of just the selected files.
Added filters and limit options.

v1.0.1

Upgrade detect-terminal to v1.1.0

About

<summary>Contributing</summary> Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

<summary>Running Tests</summary> Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

sh
$ npm install && npm test

<summary>Building docs</summary> (This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.) To generate the readme, run the following command:

sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.8.0, on May 25, 2025.

パッケージの詳細