# openurl

> Open a URL via the operating system (http: in default browser, mailto: in mail client etc.

Latest version **1.1.1** (published 2016-01-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install openurl
pnpm add openurl
yarn add openurl
bun add openurl
```

## Health

**Score 18/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2016-01-21 |
| First published | 2012-02-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/openurl) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 72 |
| Author | Axel Rauschmayer |
| Maintainers | rauschma |
| Keywords | desktop, browser |

## Links

- npm: https://www.npmjs.com/package/openurl
- Repository: https://github.com/rauschma/openurl
- Homepage: https://github.com/rauschma/openurl#readme
- Issues: https://github.com/rauschma/openurl/issues
- npm.io page: https://npm.io/package/openurl

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2016-01-21
- 1.1.0 — 2012-02-25
- 1.0.2 — 2012-02-25
- 1.0.1 — 2012-02-25
- 1.0.0 — 2012-02-25

## README

openurl – Node.js module for opening URLs
=========================================

openurl is a Node.js module for opening a URL via the operating system. This will usually trigger actions such as:

- http URLs: open the default browser
- mailto URLs: open the default email client
- file URLs: open a window showing the directory (on OS X)

Example interaction on the Node.js REPL:

    > require("openurl").open("http://rauschma.de")
    > require("openurl").open("mailto:john@example.com")
    
You can generate emails as follows:

    require("openurl").mailto(["john@example.com", "jane@example.com"],
        { subject: "Hello!", body: "This is\nan automatically sent email!\n" });
    
Install via npm:

    npm install openurl

I’m not yet terribly familiar with implementing npm packages, so any feedback is welcome
(especially experience reports on Windows and Linux, which I can’t test on).

Related reading:

- [Write your shell scripts in JavaScript, via Node.js](http://www.2ality.com/2011/12/nodejs-shell-scripting.html)

---
_Source: https://npm.io/package/openurl · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
