{"id":13526780,"url":"https://github.com/tiaanduplessis/shell-exec","last_synced_at":"2025-08-08T01:41:29.014Z","repository":{"id":22168755,"uuid":"95485471","full_name":"tiaanduplessis/shell-exec","owner":"tiaanduplessis","description":"Execute a command through the system shell","archived":false,"fork":false,"pushed_at":"2022-05-17T23:55:18.000Z","size":281,"stargazers_count":24,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-01T19:07:49.168Z","etag":null,"topics":["exec","sh","spawn"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/tiaanduplessis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-26T20:14:06.000Z","updated_at":"2024-06-16T13:30:15.000Z","dependencies_parsed_at":"2022-09-26T16:21:30.197Z","dependency_job_id":null,"html_url":"https://github.com/tiaanduplessis/shell-exec","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/tiaanduplessis/shell-exec","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fshell-exec","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fshell-exec/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fshell-exec/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fshell-exec/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tiaanduplessis","download_url":"https://codeload.github.com/tiaanduplessis/shell-exec/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tiaanduplessis%2Fshell-exec/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268408475,"owners_count":24245587,"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","status":"online","status_checked_at":"2025-08-02T02:00:12.353Z","response_time":74,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["exec","sh","spawn"],"created_at":"2024-08-01T06:01:34.663Z","updated_at":"2025-08-08T01:41:28.987Z","avatar_url":"https://github.com/tiaanduplessis.png","language":"TypeScript","readme":"\n# 🐚 shell-exec\n[![package version](https://img.shields.io/npm/v/shell-exec.svg?style=flat-square)](https://npmjs.org/package/shell-exec)\n[![package downloads](https://img.shields.io/npm/dm/shell-exec.svg?style=flat-square)](https://npmjs.org/package/shell-exec)\n[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n[![package license](https://img.shields.io/npm/l/shell-exec.svg?style=flat-square)](https://npmjs.org/package/shell-exec)\n[![make a pull request](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n\nA tiny cross-platform promise based wrapper around child_process.spawn.\n\n## Table of Contents\n\n- [🐚 shell-exec](#-shell-exec)\n  - [Table of Contents](#table-of-contents)\n  - [⚙️ Install](#️-install)\n  - [📖 Usage](#-usage)\n  - [📚 API](#-api)\n    - [`shellExec(command, options)`](#shellexeccommand-options)\n  - [💬 Contributing](#-contributing)\n  - [🪪 License](#-license)\n\n## ⚙️ Install\n\nInstall the package locally within you project folder with your package manager:\n\nWith `npm`:\n```sh\nnpm install shell-exec\n```\n\nWith `yarn`:\n```sh\nyarn add shell-exec\n```\n\nWith `pnpm`:\n```sh\npnpm add shell-exec\n```\n\n## 📖 Usage\n\n```ts\nimport shellExec from 'shell-exec'\nshellExec('echo Hi!').then(console.log).catch(console.log)\n```\n\n## 📚 API\n\n### `shellExec(command, options)`\n\n**Parameters:**\n\n- *`command`* {String | Array} - String or Array of commands to run\n- *`options`* {Object} - Options object passed to [`child_process.spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options)\n\nThe function then returns a `Promise`.\n\nSee the hosted docs [here](https://paka.dev/npm/shell-exec@1.1.0/api).\n\n## 💬 Contributing\n\nGot an idea for a new feature? Found a bug? Contributions are welcome! Please [open up an issue](https://github.com/tiaanduplessis/shell-exec/issues) or [make a pull request](https://makeapullrequest.com/).\n\n## 🪪 License\n\n[MIT © Tiaan du Plessis](./LICENSE)\n\n","funding_links":[],"categories":["Repository"],"sub_categories":["Shell"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiaanduplessis%2Fshell-exec","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftiaanduplessis%2Fshell-exec","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftiaanduplessis%2Fshell-exec/lists"}