\n \n \n\n**This project has been renamed [Screwy](https://www.npmjs.com/package/screwy)**\n\n# npm scripts gui (NSG) \nA GUI interface for npm scripts.\n\n[](https://badge.fury.io/js/npm-scripts-gui) \n\n \n
\n \n
\n \n\n*Tested on OS X Yosemite, OS X El Capitan, and Ubuntu*\n\n## Install \n\nInstall as a Dev Dependency \n```\nnpm i -D npm-scripts-gui\n```\n\n...Or Install Globally \n```\nnpm i -g npm-scripts-gui\n```\n\nInstalling as a dev dependency allows anyone who downloads your project to also get access to the gui... for free!\n\n## Instructions \n\n#### Launching\n\nTo launch Npm Script GUI (NSG), you must be in a directory with a ` package.json ` file. \n\n**If Installed Globally**\n\nThen simply run: \n` npm-script-gui ` or the shorter ` nsg `\n\n**If Installed as a Dev Dependency (Recommended)**\n\nYou must create an npm script task in the ` package.json ` that runs the ` nsg ` command and then you would run ` npm run ` from the terminal. \n\n```json\n{\n \"scripts\": {\n \"nsg\": \"nsg\"\n }\n}\n```\n\n \n\n\n#### Seeing Output \n\nWhether NSG is installed globally or as a dependency, any text output associated with any npm script task will be printed to the command line where NSG was launched. \n\n
\n \n
\n \n\n\n#### Quiting the App \n\nTo **quit** the app, it is safer to close the actual renderer window rather than quiting the process from the command line. If quiting from the command line, NSG may not do the check to make sure all processes are killed before closing. \n\n#### Killing a Running Script \n\nProcesses will die automatically when they finish or when the app is closed, but there may be times when you want to manually kill a process. Simply **double click the button**. \n\nYou can also use the `KILL` command with file watching and hotkeys.\n\n## File Watching\n\nYou can tell NSG to watch files and how to respond to those changes. You need to create a `watch` block in the `.nsgrc` file. You can watch directories, files, and use the `*` and `**` wildcards. \n\nAfter specifying a path, you need to specify **which** npm script task to respond to the file change and **how** it should respond. There are 3 options regarding the type of action to perform:\n\n- **`START`** (default, may be excluded)\n- **`KILL`**\n- **`RESTART`** (if the task is running, this will kill it and start it)\n\n**NOTE:** A whitespace is required after any of the keywords.\n\nExample:\n\n``` json\n{\n \"watch\": {\n \"src/scripts/*.js\": \"RESTART transpile-scripts\",\n \"./index.js\": \"RESTART start-server\",\n \"src/styles\": \"stylus\"\n }\n}\n```\n\nIn the example, the first watcher will restart the `transpile-scripts` task when any `.js` files are changed at `src/scripts`. The second watcher will apparently restart the server when the `index.js` file is changed. The last watcher will run `START stylus` (`START` is default).\n\n## Hotkeys \n\nHotkey combinations are configurable in the ` .nsgrc ` file. These allow you to trigger any npm scripts without needing to even click on the button or even being focused on the GUI window. \n\nAgain, you can have the GUI window minimized and the hotkeys will still trigger button clicks, and output will be sent to the terminal.\n\nHotkeys are defined in the ` .nsgrc ` file. They require the name of the npm script as the key and the hotkey combination as the value. \n\nJust as with file watching, the `START`, `RESTART`, and `KILL` commands may be used with the npm task name.\n\n**Note:** As of v0.0.17, the order of the hotkey/npm command has switched to match the file watching format. The hotkey combo should now come first.\n\n``` json\n{\n \"hotkeys\": {\n \"Control+Cmd+Alt+s\": \"start\",\n \"Control+Cmd+Alt+r\": \"RESTART start\",\n \"Control+Cmd+Alt+k\": \"KILL start\"\n }\n}\n```\n\nIn the above example, assuming the `start` command's job is to spin up a server, then `Control+Cmd+Alt+s` would start the server if it wasn't on, `Control+Cmd+Alt+r` would restart it if it was running, and `Control+Cmd+Alt+k` would shut it down. \n\n##### Multi-platform Compatibility\n\nIf you expect others to run NSG on a different platform than you are developing on, you will need to specify the platform to avoid conflicts.\n\nFor Mac, use: `OSX` or `darwin`\n\nFor Linux, use: `linux`\n\n``` json\n{\n \"hotkeys\": {\n \"darwin\": {\n \"Control+Cmd+Alt+s\": \"start\",\n \"Control+Cmd+Alt+r\": \"RESTART start\",\n \"Control+Cmd+Alt+k\": \"KILL start\"\n }\n }\n}\n```\n\nMore hotkey examples are in the Configurations section.\n\n## Configurations \n\nNSG will automatically search for a ` .nsgrc ` in the same directory as the ` package.json `. It should be in json format.\n\nThese are the available options:\n- **name**, choose different name than defined in ` package.json `\n- **primary**, the primary script buttons (red buttons) for scripts that will be ran more frequently\n- **exclude**, scripts to NOT include in the GUI\n- **alwaysOnTop**, whether the window is always in front of other windows\n- **theme**, choose a light or dark theme for window\n- **watch**, specify paths to watch and tasks to respond to file changes\n- **hotkeys**, define hotkey combinations that will trigger npm scripts\n- **silent**, suppress all of the npm's native error message and error log. (This is good for tests or linting, where you usually get error messages anyways.)\n\n**.nsgrc Example** \n\n```\n{\n \"name\": \"Qualtrics to SFDC\",\n \"primary\": [\"build\", \"run-production\", \"run-sandbox\"],\n \"exclude\": [\"scripts-gui\", \"prebuild\"],\n \"silent\": [\"lint\", \"test\"]\n \"alwaysOnTop\": true,\n \"theme\": \"dark\",\n \"watch\": {\n \"src/scripts/*.js\": \"RESTART production\",\n \"src/styles\": \"RESTART stylus\"\n },\n \"hotkeys\": {\n \"Control+Alt+b\": \"build\",\n \"Shift+Command+1\": \"run-production\",\n \"Shift+Command+2\": \"run-sandbox\",\n \"Control+Cmd+Alt+r\": \"RESTART run-production\",\n \"Control+Cmd+Alt+k\": \"KILL run-production\"\n }\n}\n```\n\nAny script not specified in ` primary ` or ` exclude ` will show up as a normal button.\n","maintainers":[{"name":"same","email":"sameaton11@gmail.com"}],"time":{"modified":"2022-06-22T09:05:05.633Z","created":"2015-12-05T00:13:48.813Z","0.0.1":"2015-12-05T00:13:48.813Z","0.0.2":"2015-12-05T01:12:12.481Z","0.0.3":"2015-12-05T20:48:22.770Z","0.0.4":"2015-12-05T21:05:53.461Z","0.0.5":"2015-12-05T21:51:36.249Z","0.0.6":"2015-12-06T03:27:10.653Z","0.0.7":"2015-12-06T03:57:53.586Z","0.0.8":"2015-12-06T16:24:23.797Z","0.0.9":"2015-12-07T03:00:04.942Z","0.0.10":"2015-12-07T15:25:33.366Z","0.0.11":"2015-12-08T07:33:26.718Z","0.0.12":"2015-12-19T20:46:05.179Z","0.0.13":"2016-01-08T05:08:08.575Z","0.0.14":"2016-01-08T05:44:25.902Z","0.0.16":"2016-01-20T16:44:21.593Z","0.0.17":"2016-01-20T17:29:51.434Z","0.0.18":"2016-01-20T19:35:16.767Z","0.0.19":"2016-01-20T19:40:57.127Z","0.0.20":"2016-02-06T19:02:21.088Z","0.0.21":"2016-02-28T01:53:52.124Z","0.0.22":"2016-02-28T02:04:24.130Z","0.0.23":"2016-02-29T22:49:16.946Z","0.0.24":"2016-02-29T23:28:06.497Z"},"author":{"name":"Sam Eaton"},"license":"MIT","readmeFilename":"README.md","homepage":"https://github.com/samueleaton/npm-scripts-gui#readme","repository":{"type":"git","url":"git+https://github.com/samueleaton/npm-scripts-gui.git"},"bugs":{"url":"https://github.com/samueleaton/npm-scripts-gui/issues"},"users":{"misterpink14":true,"addyosmani":true,"ab5124":true,"scronide":true,"oliverhuang":true,"scottfreecode":true,"ytilis":true,"jmoser-amr":true}}
![](\"https://raw.githubusercontent.com/samueleaton/design/master/npm-scripts-black.png\")
\n![](\"https://img.shields.io/badge/license-MIT-blue.svg\"){kind=icon}
\n\n![](\"https://raw.githubusercontent.com/samueleaton/design/master/npmsg.png\")
\n![](\"https://raw.githubusercontent.com/samueleaton/design/master/nsg.gif\")
\n