https://github.com/vseplet/shelly

Interaction with command line utilities for Deno
https://github.com/vseplet/shelly

bash deno fish shell shell-script ssh ts typescript zsh

Last synced: 27 days ago
JSON representation

Interaction with command line utilities for Deno

• Host: GitHub
• URL: https://github.com/vseplet/shelly
• Owner: vseplet
• License: mit
• Created: 2023-01-27T22:29:22.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-27T18:26:32.000Z (2 months ago)
• Last Synced: 2024-09-28T08:21:03.894Z (about 1 month ago)
• Topics: bash, deno, fish, shell, shell-script, ssh, ts, typescript, zsh
• Language: TypeScript
• Homepage: https://jsr.io/@vseplet/shelly
• Size: 48.8 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# shelly

[![JSR](https://jsr.io/badges/@vseplet/shelly)](https://jsr.io/@vseplet/shelly)

[![JSR Score](https://jsr.io/badges/@vseplet/shelly/score)](https://jsr.io/@vseplet/shelly)

## 👋 👋 ATTENTION!

> This package is under development and will be frequently updated. The author

> would appreciate any help, advice, and pull requests! Thank you for your

> understanding 😊

Shelly is a module designed for executing commands in TypeScript. The code

exports a function called [shelly](./source/shelly.ts) which takes in two

arguments: a command as a string or an array of strings and an optional set of

options with default values.

---

## Basic Usage:

```ts

import { shelly } from "@vseplet/shelly";

const res = await shelly(["echo", "Hello, World!"]);

console.log(res.stdout);

// -> Hello, World

```

The shelly function uses the Deno runtime to execute the specified command and

captures the output in two separate variables for standard output (stdout) and

standard error (stderr). It also catches any errors thrown during the execution

process and stores them in an error variable.

## Shell

To use Shelly for calling shells, you can use one of the provided shell-specific

functions: sh, zsh, bash, or fish. These functions accept a command string or an

array of command arguments and options, and then call the shelly function

internally with the appropriate shell command and arguments.

For example, to execute a simple command using the bash shell, you could use the

following code:

```ts

import { bash } from "@vseplet/shelly";

const res = await bash`sleep 10; echo Hello!`;

console.log(res);

// -> { stderr: "", stdout: "Hello!\n", error: null }

```

### License

[MIT](./LICENSE)