Shell utilities for deno

Shell scripting helper functions for deno.

Basic usage

Add the library to your project:

deno add jsr:@nsf/shell-util

Use it in the code:

import { sh } from "@nsf/shell-util";

const result = await sh`ls -l`;
console.log(result.stdout);

Pretty printing

Additional module for pretty printing the result of shell execution is provided. E.g.:

import { sh } from "@nsf/shell-util";
import { printShellResult } from "@nsf/shell-util/print";

printShellResult(await sh`ls -l`);

Examples

See "examples" dir for advanced usage examples.

A note on security

Main purpose of this module is to utilize /bin/bash and shells alike. It implies that a shell command will be executed at some point. Which means all the deno security permissions are cancelled. Shell script may do whatever it feels like doing disregarding the currently imposed deno filesystem access restrictions for example.

The goal here is to bridge deno world and shell scripting world. Shell scripts are not secure. Be aware what you're running. It's recommended to use this module in user facing scripts only and avoid using it when making libraries.