run-in-terminal's Introduction

run-in-terminal

Runs a command in a terminal (cmd.exe, gnome-terminal, Terminal) window.

Installation

$ npm i run-in-terminal

Usage

const { runInTerminal } = require('run-in-terminal');

runInTerminal('npm run watch');

runInTerminal('npm run watch').then(() => {
  // the terminal closed 
});

API

runInTerminal(command[, args[, options]])

Returns a promise for the spawned child process.

command

Type: string

The command to run in a terminal window.

args

Type: Array

List of string arguments.

options

Type: Object

See child_process.spawn() options.

cwd

Type: string
Default: process.cwd()

Current working directory of the child process.

License

MIT

run-in-terminal's People

Contributors

Stargazers

Watchers

run-in-terminal's Issues

How can i run othor terminal in Windows ？

I found that cmd.exe was hard code in runInTerminalWin().

But sometimes we want to use git bash or others.

So, can it become configurable?

https://github.com/Microsoft/run-in-terminal/blob/master/lib/index.ts#L69

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Commands fail to execute if argument is a path containing space

Under Windows, if a command takes e.g. path as an argument and the path contains a space, it fails to execute.

E.g. dir C:\Users\Foo Bar would fail to execute therefore it needs escaping.
The correct way of passing such a path is to escape it with quotes:
dir "C:\Users\Foo Bar".

Because Windows allow spaces in folders, it causes a lot of issues, esp. in Visual Studio Code.

Recommend Projects

microsoft / run-in-terminal Goto Github PK