@qui-cli/shell

@qui-cli Plugin: Standardized shelljs wrapper


Install

``sh
npm install @qui-cli/shell @qui-cli/core
`

Usage

`ts
import { Shell } from '@qui-cli/shell';
import { Core } from '@qui-cli/core';

// configure Shell
Root.configure({ showCommands: true });

// use Shell
Shell.exec('echo "hello world"');
`

Configuration

`ts
export type Configuration = Plugin.Configuration & {
showCommands?: boolean;
silent?: boolean;
};
`

$3

Whether or not to display the commands (rather than just their output) in the console, defaults to false.

$3

Whether or not to show command output (and, potentially, commands themselves) in the console, defaults to true.

Options

Shell exposes both showCommands and silent as user-configurable command line arguments.

Initialization

After user-provided command line arguments are parsed, Shell is updated to reflect user-specified configuration.

API

`ts
import { Shell } from '@qui-cli/shell';
`

$3

Returns the actual shelljs object.

$3

Execute an arbitrary command in the shell, optionally overriding the current silent setting.

$3

Get the result of the most-recently executed command.

$3

Whether or not the shell is currently set to silent.

$3

Whether or not the shell is currently set to showCommands`.