Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1013 Bytes

README.md

File metadata and controls

43 lines (29 loc) · 1013 Bytes

Sh

Build Status

Support via Gratipay

An Elixir module inspired by Python's 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:

  defp deps do
    [{:sh, "~> 1.1.2"}]
  end

Example

iex> Sh.echo "Hello World!"
"Hello World!\n"

Options

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

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

The equivalent call without using this feature would be:

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

Underscores

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