{"id":15701082,"url":"https://github.com/lirantal/opn-shell","last_synced_at":"2025-05-12T15:27:14.107Z","repository":{"id":45348000,"uuid":"163618497","full_name":"lirantal/opn-shell","owner":"lirantal","description":"cross-platform execution of command line programs in shells","archived":false,"fork":false,"pushed_at":"2022-04-20T12:08:39.000Z","size":840,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-06T04:47:28.517Z","etag":null,"topics":["nodejs","shell","terminal","terminal-emulator"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lirantal.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-12-30T21:22:33.000Z","updated_at":"2021-12-19T08:15:50.000Z","dependencies_parsed_at":"2022-09-17T14:30:12.472Z","dependency_job_id":null,"html_url":"https://github.com/lirantal/opn-shell","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lirantal%2Fopn-shell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lirantal%2Fopn-shell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lirantal%2Fopn-shell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lirantal%2Fopn-shell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lirantal","download_url":"https://codeload.github.com/lirantal/opn-shell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253764952,"owners_count":21960660,"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":["nodejs","shell","terminal","terminal-emulator"],"created_at":"2024-10-03T19:59:26.956Z","updated_at":"2025-05-12T15:27:14.057Z","avatar_url":"https://github.com/lirantal.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003ch1 align=\"center\"\u003e\n  opn-shell\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  Execute shell commands and detect cross-platform terminal emulators\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.org/package/opn-shell\"\u003e\u003cimg src=\"https://badgen.net/npm/v/opn-shell\"alt=\"npm version\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.org/package/opn-shell\"\u003e\u003cimg src=\"https://badgen.net/npm/license/opn-shell\"alt=\"license\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.org/package/opn-shell\"\u003e\u003cimg src=\"https://badgen.net/npm/dt/opn-shell\"alt=\"downloads\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://travis-ci.org/lirantal/opn-shell\"\u003e\u003cimg src=\"https://badgen.net/travis/lirantal/opn-shell\" alt=\"build\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/lirantal/opn-shell\"\u003e\u003cimg src=\"https://badgen.net/codecov/c/github/lirantal/opn-shell\" alt=\"codecov\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://snyk.io/test/github/lirantal/opn-shell\"\u003e\u003cimg src=\"https://snyk.io/test/github/lirantal/opn-shell/badge.svg\" alt=\"Known Vulnerabilities\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/nodejs/security-wg/blob/master/processes/responsible_disclosure_template.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/Security-Responsible%20Disclosure-yellow.svg\" alt=\"Security Responsible Disclosure\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# About\n\n`opn-shell` allows you to execute shell commands in a terminal emulator window that opens either as a tab or a new window (depending on your terminal emulator) configuration.\n\nIt will automatically detect the available terminal emulators that exist in your OS and supports both MacOS and Linux, with a fallback to the associated program on Windows.\n\n# Install\n\n```bash\nnpm install --save opn-shell\n```\n\n# Usage\n\nCall `opn-shell()` with a full path to an executable that will be launched in a terminal window.\n\nIf the promise returned by `opn-shell()` rejects then it failed to detect and open a terminal window.\n\n```js\n// @TODO\nconst TerminalLauncher = require('opn-shell')\n\nconst executable = '/usr/local/bin/my-shell-program.sh'\nTerminalLauncher.launchTerminal({ path: executable }).catch(err =\u003e {\n  console.log(err)\n})\n```\n\n## CLI\n\n```shell\nnpx opn-shell my-shell-program.sh\n```\n\n# Contributing\n\nPlease consult [CONTIRBUTING](./CONTRIBUTING.md) for guidelines on contributing to this project.\n\n# Author\n\n**opn-shell** © [Liran Tal](https://github.com/lirantal), Released under the [Apache-2.0](./LICENSE) License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flirantal%2Fopn-shell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flirantal%2Fopn-shell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flirantal%2Fopn-shell/lists"}