opn

What is opn?

The 'opn' npm package is a utility that can open stuff like websites, files, executables, etc., with their default applications. It is particularly useful for opening URLs in the default web browser from Node.js scripts.

What are opn's main functionalities?

Open websites in the default browser

This feature allows you to open a website URL in the default web browser from a Node.js script.

const opn = require('opn');
opn('https://www.example.com');

Open files with the default application

This feature allows you to open a file with its default application. For example, a PDF would be opened with the system's default PDF viewer.

const opn = require('opn');
opn('path/to/file.pdf');

Open executables

This feature allows you to open an executable file, which can be useful for launching applications from a Node.js script.

const opn = require('opn');
opn('path/to/application.exe');

Specify the app to open with

This feature allows you to specify which application to use when opening a URL or file, overriding the system default.

const opn = require('opn');
opn('https://www.example.com', {app: 'firefox'});

Other packages similar to opn

open

The 'open' package is a fork of 'opn' with more features and maintenance. It provides similar functionality to open URLs, files, and executables with their default applications or a specified one.

execa

While 'execa' is not a direct alternative to 'opn', it is a process execution tool that can be used to run any system command, including opening files and URLs with specific applications.

start

The 'start' package is a simple utility to open a file or URL with its default application. It is less feature-rich compared to 'opn' but serves a similar basic purpose.

README

open

Open stuff like URLs, files, executables. Cross-platform.

If need this for Electron, use shell.openItem() instead.

Note: The original open package was recently deprecated in favor of this package, and we got the name, so this package is now named open instead of opn. If you're upgrading from the original open package (open@0.0.5 or lower), keep in mind that the API is different.

Why?

• Actively maintained.
• Supports app arguments.
• Safer as it uses spawn instead of exec.
• Fixes most of the open original node-open issues.
• Includes the latest xdg-open script for Linux.
• Supports WSL paths to Windows apps under /mnt/*.

Install

$ npm install open

Usage

const open = require('open');

// Opens the image in the default image viewer
(async () => {
	await open('unicorn.png', {wait: true});
	console.log('The image viewer app closed');

	// Opens the url in the default browser
	await open('https://sindresorhus.com');

	// Specify the app to open in
	await open('https://sindresorhus.com', {app: 'firefox'});

	// Specify app arguments
	await open('https://sindresorhus.com', {app: ['google chrome', '--incognito']});
})();

API

It uses the command open on macOS, start on Windows and xdg-open on other platforms.

open(target, [options])

Returns a promise for the spawned child process. You would normally not need to use this for anything, but it can be useful if you'd like to attach custom event listeners or perform other operations directly on the spawned process.

target

Type: string

The thing you want to open. Can be a URL, file, or executable.

Opens in the default app for the file type. For example, URLs opens in your default browser.

options

Type: Object

wait

Type: boolean
Default: false

Wait for the opened app to exit before fulfilling the promise. If false it's fulfilled immediately when opening the app.

Note that it waits for the app to exit, not just for the window to close.

On Windows, you have to explicitly specify an app for it to be able to wait.

app

Type: string | string[]

Specify the app to open the target with, or an array with the app and app arguments.

The app name is platform dependent. Don't hard code it in reusable modules. For example, Chrome is google chrome on macOS, google-chrome on Linux and chrome on Windows.

You may also pass in the app's full path. For example on WSL, this can be /mnt/c/Program Files (x86)/Google/Chrome/Application/chrome.exe for the Windows installation of Chrome.

Related

• opn-cli - CLI for this module
• open-editor - Open files in your editor at a specific line and column

License

MIT © Sindre Sorhus