https://github.com/devinus/sh

Run programs as functions in Elixir
https://github.com/devinus/sh

elixir shell

Last synced: 18 days ago
JSON representation

Run programs as functions in Elixir

• Host: GitHub
• URL: https://github.com/devinus/sh
• Owner: devinus
• License: unlicense
• Created: 2014-02-22T20:56:13.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-08-16T00:50:33.000Z (almost 6 years ago)
• Last Synced: 2024-03-15T06:04:12.885Z (4 months ago)
• Topics: elixir, shell
• Language: Elixir
• Size: 13.7 KB
• Stars: 144
• Watchers: 5
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars - sh

README

        
# Sh

[![Build Status](https://api.travis-ci.org/devinus/sh.svg?branch=master)](https://travis-ci.org/devinus/sh)

[![Support via Gratipay](https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.png)](https://gratipay.com/devinus/)

An Elixir module inspired by Python's [sh](http://amoffat.github.io/sh/)

package. `Sh` allows you to call any program as if it were a function.

## Adding Sh to Your Project

To use Sh with your projects, simply edit your mix.exs file and add it as a dependency:

```elixir

  defp deps do

    [{:sh, "~> 1.1.2"}]

  end

```

## Example

```iex

iex> Sh.echo "Hello World!"

"Hello World!\n"

```

## Options

`Sh` commands accept as the last argument a list of options.

```elixir

Sh.curl "http://example.com/", o: "page.html", silent: true

""

```

The equivalent call without using this feature would be:

```elixir

Sh.curl "-o", "page.html", "--silent", "http://example.com/"

```

## Underscores

Underscores in a program name or keyword options are converted to dashes.