Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

opn

Package Overview
Dependencies
1
Maintainers
1
Versions
22
Issues
File Explorer

Advanced tools

opn

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

    6.0.0latest

Version published
Maintainers
1
Weekly downloads
7,512,138
decreased by-9.95%

Weekly downloads

Readme

Source

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 ([email protected] 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.

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

License

MIT © Sindre Sorhus

Keywords

FAQs

What is opn?

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

Is opn popular?

The npm package opn receives a total of 5,952,937 weekly downloads. As such, opn popularity was classified as popular.

Is opn well maintained?

We found that opn demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 26 Mar 2019

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc