Run a Shell Command

Bun Shell is a cross-platform bash-like shell built in to Bun. It runs shell commands in JavaScript and TypeScript. To get started, import the $ function from the bun package and use it to run shell commands.

foo.ts

import { $ } from "bun";

await $`echo Hello, world!`; // => "Hello, world!"

The $ function is a tagged template literal that runs the command and returns a promise that resolves with the command’s output.

foo.ts

import { $ } from "bun";

const output = await $`ls -l`.text();
console.log(output);

To get each line of the output as an array, use the lines method.

foo.ts

import { $ } from "bun";

for await (const line of $`ls -l`.lines()) {
  console.log(line);
}

See Docs > API > Shell for complete documentation.

Overview

Deployment

Runtime & Debugging

Utilities

Ecosystem & Frameworks

HTTP & Networking

WebSocket

Processes & System

Package Manager

Test Runner

Runtime & Debugging

Module System

File System

Utilities

HTML Processing

Binary Data

Streams

Run a Shell Command