mirror of
https://github.com/kowainik/shellmet.git
synced 2024-09-11 09:55:42 +03:00
217a9b34f6
* [#3] Write usage example in the README Resolves #3 * Fix CI * Update README.md [skip ci] Co-Authored-By: ChShersh <kovanikov@gmail.com> * Update README.md [skip ci] Co-Authored-By: ChShersh <kovanikov@gmail.com>
56 lines
1.6 KiB
Markdown
56 lines
1.6 KiB
Markdown
# shellmet
|
|
|
|
[](https://travis-ci.org/kowainik/shellmet)
|
|
[](https://hackage.haskell.org/package/shellmet)
|
|
[](LICENSE)
|
|
[](http://stackage.org/lts/package/shellmet)
|
|
[](http://stackage.org/nightly/package/shellmet)
|
|
|
|
Out of the shell solution for scripting in Haskell. Shellmet provides an easy and
|
|
convenient way to call shell commands from Haskell programs.
|
|
|
|
## Usage example
|
|
|
|
This README contains the usage example of the `shellmet` library. The example is
|
|
runnable. You can build and execute with the following command:
|
|
|
|
```shell
|
|
cabal new-run readme
|
|
```
|
|
|
|
### Setting up
|
|
|
|
Since this tutorial is written using Literate Haskell, first, let's write all
|
|
necessary pragmas and imports.
|
|
|
|
```haskell
|
|
{-# LANGUAGE OverloadedStrings #-}
|
|
|
|
import Data.Semigroup ((<>))
|
|
import Shellmet (($|))
|
|
|
|
import qualified Data.Text as T
|
|
```
|
|
|
|
### Simple scripting example
|
|
|
|
Below you can see how easy it is to interact with shell commands in Haskell:
|
|
|
|
```haskell
|
|
main :: IO ()
|
|
main = do
|
|
"echo" ["Starting shellmet readme..."]
|
|
text <- "cat" $| ["README.md"]
|
|
let cnt = T.pack $ show $ length $ T.lines text
|
|
"echo" ["Number of lines in this README: " <> cnt]
|
|
```
|
|
|
|
And the output is:
|
|
|
|
```
|
|
⚙ echo 'Starting shellmet readme...'
|
|
Starting shellmet readme...
|
|
⚙ echo 'Number of lines in this README: 54'
|
|
Number of lines in this README: 54
|
|
```
|