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.
opn
A better node-open. Opens stuff like websites, files, executables. Cross-platform.
Why?
- Actively maintained
- Includes the latest xdg-open script
- Fixes most of the
node-open
issues
Install
$ npm install --save opn
Usage
var opn = require('opn');
opn('http://sindresorhus.com');
opn('http://sindresorhus.com', 'firefox');
opn('unicorn.png');
API
Uses the command open
on OS X, start
on Windows and xdg-open
on other platforms.
opn(target, [app, callback])
target
Required
Type: string
The thing you want to open. Can be a url, file, or executable.
Opens in the default app for the file type. Eg. urls opens in your default browser.
app
Type: string
Specify the app to open the target
with.
The app name is platform dependent. Don't hard code it in reusable modules.
callback(err)
Type: function
Executes when the opened app exits.
On Windows you have to explicitly specify an app for it to be able to wait.
CLI
You can also use it as a CLI app by installing it globally:
$ npm install --global opn
Usage
$ opn --help
Usage
$ opn <file|url> [app]
Example
$ opn http://sindresorhus.com
$ opn http://sindresorhus.com firefox
$ opn unicorn.png
License
MIT © Sindre Sorhus