{"id":13582978,"url":"https://github.com/shelljs/plugin-open","last_synced_at":"2025-04-06T18:31:44.721Z","repository":{"id":45095629,"uuid":"63991830","full_name":"shelljs/plugin-open","owner":"shelljs","description":"An example shelljs-plugin to open a file with its default application","archived":false,"fork":false,"pushed_at":"2025-03-09T01:43:23.000Z","size":37,"stargazers_count":9,"open_issues_count":1,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-22T16:52:52.967Z","etag":null,"topics":["shelljs","shelljs-plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shelljs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2016-07-23T00:47:16.000Z","updated_at":"2025-03-09T01:43:25.000Z","dependencies_parsed_at":"2024-04-08T15:51:38.905Z","dependency_job_id":null,"html_url":"https://github.com/shelljs/plugin-open","commit_stats":{"total_commits":38,"total_committers":2,"mean_commits":19.0,"dds":"0.39473684210526316","last_synced_commit":"c604a8904e91648a6a2bce45afc5596b0a5f77ba"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelljs%2Fplugin-open","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelljs%2Fplugin-open/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelljs%2Fplugin-open/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shelljs%2Fplugin-open/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shelljs","download_url":"https://codeload.github.com/shelljs/plugin-open/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247530964,"owners_count":20953879,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["shelljs","shelljs-plugin"],"created_at":"2024-08-01T15:03:10.237Z","updated_at":"2025-04-06T18:31:44.447Z","avatar_url":"https://github.com/shelljs.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# shelljs-plugin-open\n\n[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/shelljs/plugin-open/main.yml?style=flat-square\u0026logo=github)](https://github.com/shelljs/plugin-open/actions/workflows/main.yml)\n[![npm](https://img.shields.io/npm/v/shelljs-plugin-open.svg?style=flat-square)](https://www.npmjs.com/package/shelljs-plugin-open)\n[![shelljs-plugin](https://img.shields.io/badge/shelljs-plugin-brightgreen.svg?style=flat-square)](https://github.com/shelljs/shelljs/wiki/Using-ShellJS-Plugins)\n\nA [ShellJS](https://github.com/shelljs/shelljs) plugin for the `open()` command\nto open a file (or URL) with its default application. This is largely based on\n[opener](https://github.com/domenic/opener).\n\nThis is designed to imitate the `open` command on macOS. Here's the\nequivalent commands for other systems:\n\n - macOS\n\n   ```bash\n   $ open file.txt # opens in a text editor\n   ```\n\n - Linux\n\n   ```bash\n   $ xdg-open file.txt # opens in a text editor\n   ```\n\n - Windows\n\n   ```\n   \u003e start file.txt\n   ```\n\n## Installation\n\n```bash\n$ npm install --save shelljs\n$ npm install --save shelljs-plugin-open\n```\n\n## Usage\n\nShellJS unofficially has the capacity for plugins (the API is likely to change a\nbit) since v0.7.1. Although we *don't recommend* developing for this yet, this\nplugin is designed to test that API, and we will adapt it along with changes to\nShellJS up until official plugin support. To use this plugin, you must use\nexactly version v0.7.1 (although, eventually this will support v1.0.0+).\n\nTo use this plugin in your project, include it like so:\n\n```javascript\nvar shell = require('shelljs');\nrequire('shelljs-plugin-open');\n\n// Ex. usage:\nshell.open('file.txt'); // the plugin is now available!\n```\n\n## Supported systems\n\n - Linux (all variants)\n - macOS\n - Windows\n\nThis is supported for Node v0.11+\n\n## Writing plugins\n\nIf you're interested in taking a look at the current state of the plugin API,\ntake a look at [index.js](index.js). This has helpful comments explaining the\nnecessary boilerplate for writing a plugin. For an example usage of the plugin,\ntake a look at [test/test.js](test/test.js).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshelljs%2Fplugin-open","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshelljs%2Fplugin-open","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshelljs%2Fplugin-open/lists"}