Skip to content
/ esy-bash Public

Installation utilities for Cygwin - primed for Reason/OCaml

License

Notifications You must be signed in to change notification settings

esy/esy-bash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5e887db · Jun 9, 2023
Dec 24, 2021
Dec 24, 2021
Jul 9, 2018
Oct 23, 2018
Dec 8, 2021
May 8, 2019
Jun 23, 2018
Jun 22, 2018
Nov 10, 2018
May 2, 2019
Jun 9, 2023
Oct 23, 2018
Jul 4, 2018
Jun 25, 2018
Jun 28, 2018
Nov 1, 2018
Dec 24, 2021
Dec 24, 2021
Nov 10, 2018

Repository files navigation

esy-bash

Build Status npm version

Installation utilities for a bash environment - primed for Reason/OCaml

This package is intended to smooth over cases where OCaml packages rely on Unix utilities or a Bash environment.

On Linux and OS X, this package is essentially a no-op. On Windows, we install an isolated cygwin environment, ready to use for OCaml/OPAM, that we use to run a bash shell.

Installation

 npm install

Installation on Windows does the following:

Usage

Command Line

The esy-bash command runs a script in a bash shell. On Linux and OS X, this just uses the default bash shell. On Windows, this delegates to the installed cygwin environment:

esy-bash echo 'HI'

API

An API is also bundled:

const { bashExec } = require("esy-bash")

await bashExec("ls -a")

License

This source code is licensed under the MIT License.

When installing, several other dependencies are downloaded - like Cygwin and the GNU utilities. These are bound by their own license terms, primarily the GPL License