{"_id":"@expo/sudo-prompt","_rev":"4308610","name":"@expo/sudo-prompt","description":"Run a command using sudo, prompting the user with an OS dialog if necessary","dist-tags":{"latest":"9.3.2"},"maintainers":[{"name":"alanhughes","email":""},{"name":"brentvatne","email":"brentvatne@gmail.com"},{"name":"bycedric","email":"me@bycedric.com"},{"name":"evanbacon","email":"baconbrix@gmail.com"},{"name":"expo-bot","email":""},{"name":"expoadmin","email":""},{"name":"exponent","email":""},{"name":"ide","email":"ide+npm@jameside.com"},{"name":"kudochien","email":"ckchien@gmail.com"},{"name":"philpl","email":""},{"name":"tsapeta","email":"sapeta.tomasz@gmail.com"},{"name":"wschurman","email":"wschurman@gmail.com"}],"time":{"modified":"2026-04-07T21:43:39.000Z","created":"2025-01-23T09:45:12.071Z","9.3.2":"2025-01-23T09:45:12.071Z"},"users":{},"author":{"name":"Joran Dirk Greef"},"repository":{"type":"git","url":"git+https://github.com/expo/sudo-prompt.git"},"versions":{"9.3.2":{"name":"@expo/sudo-prompt","public":true,"version":"9.3.2","description":"Run a command using sudo, prompting the user with an OS dialog if necessary","main":"index.js","types":"index.d.ts","repository":{"type":"git","url":"git+https://github.com/expo/sudo-prompt.git"},"keywords":["sudo","os","dialog","prompt","command","exec","user access control","UAC","privileges","administrative","elevate","run as administrator"],"author":{"name":"Joran Dirk Greef"},"license":"MIT","bugs":{"url":"https://github.com/expo/sudo-prompt/issues"},"homepage":"https://github.com/expo/sudo-prompt","scripts":{},"publishConfig":{"access":"public"},"_id":"@expo/sudo-prompt@9.3.2","gitHead":"b43b811c2657172847dfbc9ba4d56185c6c76bf8","_nodeVersion":"22.11.0","_npmVersion":"10.9.0","dist":{"shasum":"0fd2813402a42988e49145cab220e25bea74b308","size":17344,"noattachment":false,"key":"/@expo/sudo-prompt/-/@expo/sudo-prompt-9.3.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/@expo/sudo-prompt/download/@expo/sudo-prompt-9.3.2.tgz"},"_npmUser":{"name":"philpl","email":"phil@kitten.sh"},"directories":{},"maintainers":[{"name":"alanhughes","email":""},{"name":"brentvatne","email":"brentvatne@gmail.com"},{"name":"bycedric","email":"me@bycedric.com"},{"name":"evanbacon","email":"baconbrix@gmail.com"},{"name":"expo-bot","email":""},{"name":"expoadmin","email":""},{"name":"exponent","email":""},{"name":"ide","email":"ide+npm@jameside.com"},{"name":"kudochien","email":"ckchien@gmail.com"},{"name":"philpl","email":""},{"name":"tsapeta","email":"sapeta.tomasz@gmail.com"},{"name":"wschurman","email":"wschurman@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/sudo-prompt_9.3.2_1737625511893_0.7645354651697307"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2025-01-23T09:45:12.071Z","publish_time":1737625512071,"_source_registry_name":"default","_cnpm_publish_time":1737625512071}},"readme":"# sudo-prompt\n\n> [!NOTE]\n> This is a fork at [`expo/sude-prompt`](https://github.com/expo/sudo-prompt) to resolve deprecated Node APIs.\n> Upstreams:\n> - [`@vscode/sudo-prompt`](https://github.com/bpasero/sudo-prompt)\n> - [`sudo-prompt`](https://github.com/jorangreef/sudo-prompt) (deprecated)\n\nRun a non-graphical terminal command using `sudo`, prompting the user with a graphical OS dialog if necessary. Useful for background Node.js applications or native Electron apps that need `sudo`.\n\n## Cross-Platform\n`sudo-prompt` provides a native OS dialog prompt on **macOS**, **Linux** and **Windows**.\n\n![macOS](https://raw.githubusercontent.com/jorangreef/sudo-prompt/master/macos.png)\n\n![Linux](https://raw.githubusercontent.com/jorangreef/sudo-prompt/master/linux.png)\n\n![Windows](https://raw.githubusercontent.com/jorangreef/sudo-prompt/master/windows.png)\n\n## Installation\n`sudo-prompt` has no external dependencies and does not require any native bindings.\n```\nnpm install sudo-prompt\n```\n\n## Usage\nNote: Your command should not start with the `sudo` prefix.\n```javascript\nvar sudo = require('sudo-prompt');\nvar options = {\n  name: 'Electron',\n  icns: '/Applications/Electron.app/Contents/Resources/Electron.icns', // (optional)\n};\nsudo.exec('echo hello', options,\n  function(error, stdout, stderr) {\n    if (error) throw error;\n    console.log('stdout: ' + stdout);\n  }\n);\n```\n\n`sudo-prompt` will use `process.title` as `options.name` if `options.name` is not provided. `options.name` must be alphanumeric only (spaces are supported) and at most 70 characters.\n\n`sudo-prompt` will preserve the current working directory on all platforms. Environment variables can be set explicitly using `options.env`.\n\n**`sudo-prompt.exec()` is different to `child-process.exec()` in that no child process is returned (due to platform and permissions constraints).**\n\n## Behavior\nOn macOS, `sudo-prompt` should behave just like the `sudo` command in the shell. If your command does not work with the `sudo` command in the shell (perhaps because it uses `>` redirection to a restricted file), then it may not work with `sudo-prompt`. However, it is still possible to use sudo-prompt to get a privileged shell, [see this closed issue for more information](https://github.com/jorangreef/sudo-prompt/issues/1).\n\nOn Linux, `sudo-prompt` will use either `pkexec` or `kdesudo` to show the password prompt and run your command. Where possible, `sudo-prompt` will try and get these to mimic `sudo`. Depending on which binary is used, and due to the limitations of some binaries, the name of your program or the command itself may be displayed to your user. `sudo-prompt` will not use `gksudo` since `gksudo` does not support concurrent prompts. Passing `options.icns` is currently not supported by `sudo-prompt` on Linux. Patches are welcome to add support for icons based on `polkit`.\n\nOn Windows, `sudo-prompt` will elevate your command using User Account Control (UAC). Passing `options.name` or `options.icns` is currently not supported by `sudo-prompt` on Windows.\n\n## Non-graphical terminal commands only\nJust as you should never use `sudo` to launch any graphical applications, you should never use `sudo-prompt` to launch any graphical applications. Doing so could cause files in your home directory to become owned by root. `sudo-prompt` is explicitly designed to launch non-graphical terminal commands. For more information, [read this post](http://www.psychocats.net/ubuntu/graphicalsudo).\n\n## Concurrency\nOn systems where the user has opted to have `tty-tickets` enabled (most systems), each call to `exec()` will result in a separate password prompt. Where `tty-tickets` are disabled, subsequent calls to `exec()` will still require a password prompt, even where the user's `sudo` timestamp file remains valid, due to edge cases with `sudo` itself, [see this discussion for more information](https://github.com/jorangreef/sudo-prompt/pull/76).\n\nYou should never rely on `sudo-prompt` to execute your calls in order. If you need to enforce ordering of calls, then you should explicitly order your calls in your application. Where your commands are short-lived, you should always queue your calls to `exec()` to make sure your user is not overloaded with password prompts.\n\n## Invalidating the timestamp\nOn macOS and Linux, you can invalidate the user's `sudo` timestamp file to force the prompt to appear by running the following command in your terminal:\n\n```sh\n$ sudo -k\n```\n","_attachments":{},"homepage":"https://github.com/expo/sudo-prompt","bugs":{"url":"https://github.com/expo/sudo-prompt/issues"},"license":"MIT"}