• Stars
    star
    942
  • Rank 48,520 (Top 1.0 %)
  • Language
    Haskell
  • License
    BSD 3-Clause "New...
  • Created almost 10 years ago
  • Updated 5 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Shell programming, Haskell style

turtle

Turtle is a reimplementation of the Unix command line environment in Haskell so that you can use Haskell as a scripting language or a shell. Think of turtle as coreutils embedded within the Haskell language.

Quick start

$ stack ghci turtle
Prelude> :set -XOverloadedStrings
Prelude> import Turtle

... and try out some basic filesystem operations:

Prelude Turtle> cd "/tmp"
Prelude Turtle> mkdir "test"
Prelude Turtle> touch "test/foo"
Prelude Turtle> testfile "test/foo"
True
Prelude Turtle> rm "test/foo"
Prelude Turtle> testfile "test/foo"
False
Prelude Turtle> rmdir "test"
Prelude Turtle> view (lstree "/usr/lib")
FilePath "/usr/lib/gnome-screensaver"
FilePath "/usr/lib/gnome-screensaver/gnome-screensaver-dialog"
FilePath "/usr/lib/libplist.so.1.1.8"
FilePath "/usr/lib/tracker"
FilePath "/usr/lib/tracker/tracker-miner-fs"
FilePath "/usr/lib/tracker/tracker-extract"
FilePath "/usr/lib/tracker/tracker-writeback"
FilePath "/usr/lib/tracker/tracker-search-bar"
FilePath "/usr/lib/tracker/tracker-store"
FilePath "/usr/lib/libgif.so.4.1"
...

To learn more, read the turtle tutorial.

Goals

The turtle library focuses on being a "better Bash" by providing a typed and light-weight shell scripting experience embedded within the Haskell language. If you have a large shell script that is difficult to maintain, consider translating it to a "turtle script" (i.e. a Haskell script using the turtle library).

Among typed languages, Haskell possesses a unique combination of features that greatly assist scripting:

  • Haskell has global type inference, so all type annotations are optional
  • Haskell is functional and not object-oriented, so boilerplate is minimal
  • Haskell can be type-checked and interpreted quickly (< 1 second startup time)

Features

  • Batteries included: Command an extended suite of predefined utilities

  • Interoperability: You can still run external shell commands

  • Portability: Works on Windows, OS X, and Linux

  • Exception safety: Safely acquire and release resources

  • Streaming: Transform or fold command output in constant space

  • Patterns: Use typed regular expressions that can parse structured values

  • Formatting: Type-safe printf-style text formatting

  • Modern: Supports text and system-filepath

Caveats

Unlike shelly, this package does not use a monad transformer to keep track of state like the current working directory or environment variables. Instead, all state changes are made to the process's global state.

Development Status

Build Status

turtle's types and idioms are reasonably complete and I don't expect there to be significant changes to the library's core API. The only major functionality that I might add in the future would be to wrap optparse-applicative in a simpler API.

The set of available tools currently covers as many filesystem utilities as I could find across Hackage, but I would like to continue to add to the set of available tools to minimally match coreutils.

Community Resources

How to contribute

  • Contribute more utilities

  • Write turtle tutorials

License (BSD 3-clause)

Copyright (c) 2017 Gabriella Gonzalez
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of Gabriella Gonzalez nor the names of other contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

More Repositories

1

post-rfc

Blog post previews in need of peer review
2,189
star
2

haskell-nix

Nix and Haskell in production
Nix
1,135
star
3

bench

Command-line benchmark tool
Haskell
867
star
4

simple-twitter

A bare-bones Twitter clone implemented in a single file
Nix
720
star
5

pipes

Compositional pipelines
Haskell
478
star
6

nixos-in-production

Source files for the book "NixOS in Production"
HCL
461
star
7

grace

A ready-to-fork interpreted functional language with type inference
JavaScript
385
star
8

Haskell-Morte-Library

A bare-bones calculus-of-constructions
Haskell
367
star
9

nix-diff

Explain why two Nix derivations differ
Haskell
328
star
10

slides

Slides from talks that I give
Haskell
294
star
11

optparse-generic

Auto-generate a command-line parser for your datatype
Haskell
207
star
12

Haskell-Typed-Spreadsheet-Library

Typed and composable spreadsheets
Haskell
187
star
13

foldl

Composable, streaming, and efficient left folds
Haskell
158
star
14

terraform-nixos-ng

Terraform modules for NixOS and spiritual successor to the terraform-nixos project
HCL
122
star
15

Haskell-Annah-Library

Distributed programming language that desugars to Morte
Haskell
92
star
16

Haskell-Lens-Tutorial-Library

The missing tutorial module for the lens library
Haskell
81
star
17

macos-builder

Bootstrap a Linux build VM on macOS
Nix
78
star
18

haskell-in-the-large

A book about large-scale design in Haskell
75
star
19

Haskell-Errors-Library

Type-safe error handling
Haskell
64
star
20

Haskell-MVC-Library

Model-view-controller
Haskell
62
star
21

list-transformer

List monad transformer
Haskell
60
star
22

HasCal

Haskell embedding of PlusCal
Haskell
59
star
23

nixfmt

Automatic code formatter for the Nix programming language
Haskell
52
star
24

managed

A monad for managed values
Haskell
49
star
25

Haskell-MMorph-Library

Monad morphisms
Haskell
47
star
26

dhall-manual

The Dhall Configuration Language Manual
46
star
27

pipes-concurrency

Concurrency for the pipes ecosystem
Haskell
43
star
28

Purescript-to-Python

A compiler from Purescript to Python
Haskell
43
star
29

dhall-dot

Dhall support for the DOT language for graphviz
Dhall
38
star
30

suns-search

Fast all-atom protein structural search engine
Haskell
37
star
31

Haskell-Nix-Derivation-Library

Parse and render *.drv files
Haskell
35
star
32

servant-crud

Example CRUD web server+client using Servant
Haskell
34
star
33

Haskell-Total-Library

Exhaustive pattern matching using lenses, traversals, and prisms
Haskell
31
star
34

Haskell-Server-Generic-Library

Auto-generate a server for your datatype
Haskell
30
star
35

Haskell-Pipes-Parse-Library

Parsing for the pipes ecosystem
Haskell
28
star
36

Haskell-Pipes-Safe-Library

Safety for the pipes ecosystem
Haskell
26
star
37

Haskell-Bears-Library

Relational algebra
Haskell
25
star
38

Haskell-Succinct-Vector-Library

Succinct vectors
Haskell
20
star
39

graph

Dhall support for directed graphs with labeled vertices
Dhall
19
star
40

spire

Algorithmically solve Slay the Spire
Haskell
19
star
41

Haskell-Pipes-HTTP-Library

HTTP client with pipes interface
Haskell
18
star
42

Haskell-Optional-Args-Library

Optional function arguments
Haskell
16
star
43

defaultable-map

Applicative maps
Haskell
15
star
44

Haskell-Pipes-ByteString-Library

ByteString support for pipes
Haskell
14
star
45

dhall-semver

Dhall support for semantic version numbers
Dhall
14
star
46

dhall-kubernetes-charts

This repository is superseded by https://github.com/EarnestResearch/dhall-packages
13
star
47

Haskell-Index-Core-Library

Indexed Types
Haskell
13
star
48

Haskell-Pipes-Extras-Library

Miscellaneous utilities for pipes
Haskell
11
star
49

composable-path

Typed paths that are composable
Haskell
11
star
50

political-notes

Markdown
11
star
51

Haskell-MVC-Updates-Library

Concurrent and combinable updates
Haskell
10
star
52

Haskell-Event-Source-Library

Event sourcing library
Haskell
10
star
53

Haskell-RCPL-Library

Concurrent console input and output
Haskell
10
star
54

sig

Blazing fast signature detection
Haskell
10
star
55

Haskell-Break-Library

Break from a loop
Haskell
9
star
56

ghcjs-demo

Example GHCJS demo
Haskell
8
star
57

Haskell-Nordom-Library

A variation on Morte that is close to the machine (obsoleted in favor of Dhall)
Haskell
7
star
58

Haskell-Dhall-Edit-Library

Autogenerate a curses editor for a Dhall configuration file
Haskell
7
star
59

Haskell-MVC-Updates-Examples-Library

Examples for the mvc-updates library
Haskell
7
star
60

Haskell-DirStream-Library

Easily stream directory contents in constant memory
Haskell
7
star
61

Haskell-Free-Monads-Library

Free monads
Haskell
6
star
62

pipes-web

Deploy pipes over the web
Haskell
5
star
63

Haskell-Transformers-Free-Library

Free monad transformers
Haskell
5
star
64

suns-cmd

Command line client for the Suns search engine
Haskell
5
star
65

tiktoken

Haskell
5
star
66

pipes-platform

The full ecosystem of pipes libraries
Haskell
4
star
67

pipes-group

Group streams into substreams
Haskell
4
star
68

delta-lambda

test language for an automath style type system
Haskell
3
star
69

holepunch

NixOS configuration for tunneling an inbound SSH connection over an outbound HTTPS connection
Nix
3
star
70

Haskell-Pipes-Foldl-Library

Folding utilities for pipes
Haskell
3
star
71

Haskell-Crunch-Library

Fast serialization and deserialization
Haskell
3
star
72

Haskell-Aurora-Library

Haskell-Aurora-Library
Haskell
2
star
73

pipes-ecosystem

testing the pipes suite of libraries
Haskell
2
star
74

Haskell-Record-Library

Command line utility to record command environments and output
Haskell
2
star
75

pipes-process

Shell support for pipes
Haskell
2
star
76

Haskell-Pipes-Handle-Library

Model traditional handles using pipes
Haskell
1
star
77

twill

Twilio API interaction for Haskell
Haskell
1
star
78

min-standalone

Minimal reproducing case for standalone-haddock issue
Haskell
1
star
79

emitter

haskell pipes example
Haskell
1
star
80

code-kata-439

Haskell
1
star