turtle

Shell programming, Haskell-style

Version on this page:1.5.14
LTS Haskell 22.36:1.6.2@rev:3
Stackage Nightly 2024-10-06:1.6.2@rev:3
Latest on Hackage:1.6.2@rev:3

See all snapshots turtle appears in

BSD-3-Clause licensed by Gabriel Gonzalez
Maintained by [email protected]
This version can be pinned in stack with:turtle-1.5.14@sha256:a6c4f3abd49542398209c8cc001bc7c7d3a4ea6a66a954611b337e15b8d59249,4744

turtle is a reimplementation of the Unix command line environment in Haskell so that you can use Haskell as both a shell and a scripting language.

Features include:

  • 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

Read Turtle.Tutorial for a detailed tutorial or Turtle.Prelude for a quick-start guide

turtle is designed to be beginner-friendly, but as a result lacks certain features, like tracing commands. If you feel comfortable using turtle then you should also check out the Shelly library which provides similar functionality.

Changes

1.5.14

1.5.13

1.5.12

  • Increase upper bound on containers

1.5.11

1.5.10

  • Increase upper bound on doctest and criterion

1.5.9

  • Add symlink

1.5.8

1.5.7

  • Increase upper bound on doctest

1.5.6

  • Increase upper bound on exceptions

1.5.5

  • Increase upper bound on criterion

1.5.4

  • Increase upper bound on exceptions

1.5.3

  • Increase upper bound on doctest

1.5.2

  • Increase upper bound on async

1.5.1

  • GHC 8.4 support
  • Re-export encodeString/decodeString
  • Update tutorial to use stack script
  • Increase upper bounds on dependencies

1.5.0

  • BREAKING CHANGE: Add MonadCatch instance for Shell
    • This requires a breaking change to the internal implementation of Shell
    • Most breaking changes can be fixed by replacing the Shell constructor with the newly added _Shell utility for ease of migration
    • If you don’t use the Shell constructor then this change likely does not affect you
  • Add eprintf

1.4.5

  • Add grepText, uniq, nub, sort to Turtle.Prelude
  • Increase upper bound on unix-compat

1.4.4

  • Fix small mistake in tutorial

1.4.3

  • Increase upper bound on doctest

1.4.2

  • Add sed{Prefix,Suffix,Entire} and inplace{Prefix,Suffix,Entire}

1.4.1

  • Increase upper bound on doctest

1.4.0

  • BREAKING CHANGE: Remove unnecessary Maybe from type of single
  • BREAKING CHANGE: Consolidate searchable and executable
  • stream{,WithErr} now throws an ExitCode on failure

1.3.6

  • Build against ghc-8.2
  • Relax upper bound on optparse-applicative and foldl

1.3.5

  • Increase upper bound on foldl

1.3.4

  • Bug fix: cptree now correctly copies files instead of creating directories of the same name
  • Increase upper bound on criterion

1.3.3

  • Bug fix: Change textToLines to behave like Data.Text.splitOn "\n" instead of Data.Text.unlines
    • This fixes weird behavior around handling empty strings. splitOn does the right thing, but unlines does not. For example, this indirectly fixes a regression in sed, which would discard empty lines
  • Bug fix: which/whichAll now behave correctly on Windows
  • Add new cptree/single utilities
  • Documentation fixes

1.3.2

  • Fix bugs in subprocess management
  • Generalize type of repr to return any type that implements IsString
  • Add optLine, argLine, and l utilities to simplify working with Lines

1.3.1

  • find no longer follows symlinks
  • Increase upper bound on directory

1.3

  • BREAKING CHANGE: Several utilities now produce and consume Lines instead of Text
    • The purpose of this change is to fix a very common source of confusion for new users about which utilities are line-aware
    • Most of the impact on existing code is just changing the types by replacing Text with Line in the right places. The change at the term level should be small (based on the changes to the tutorial examples)
  • BREAKING CHANGE: Description now wraps a Doc instead of Text
    • In the most common case where users use string literals this has no effect
  • New Turtle.Bytes module that provides ByteString variations on subprocess runners
  • Fix du reporting incorrect sizes for directories
  • Add pushd, stat, lstat, which, procStrictWithErr, shellStrictWithErr, onFiles, header, subcommandGroup, and parallel
  • Backport need to GHC 7.6.3
  • Fix missing help text for option parsers
  • Fix bugs in subprocess management

1.2.8

  • Increase upper bound on time and transformers
  • Fix incorrect lower bound for base

1.2.7

  • Increase upper bound on clock dependency

1.2.6

  • Generalize several types to use MonadManaged
  • Generalize type of printf to use MonadIO
  • Add system, and copymod
  • Fix rmtree to more accurately match behavior of rm -r

1.2.5

  • Add printf, utc, procs, and shells

1.2.4

  • Generalize type of d format specifier to format any Integral type
  • Add inprocWithErr, inShellWithErr, inplace, and sz

1.2.3

  • Add subcommand and testpath
  • Use line buffering for Text-based subprocesses

1.2.2

  • Re-export with
  • Add begins, ends, contains, lowerBounded, mktempfile, nl, paste endless, lsif, and cut
  • Fix subprocess management bugs

1.2.1

  • Fix subprocess management bugs

1.2.0

  • BREAKING CHANGE: du now returns a Size instead of an Integer
  • New Turtle.Options module that provides convenient utilities for options parsing
  • Add hostname, outhandle, stderr, cache, countChars, countWords, and countLines
  • Fix subprocess management bugs

1.1.1

  • Add bounded, upperBounded, procStrict, shellStrict, arguments
  • Add several Permissions-related commands
  • Generalize several types to MonadIO

1.1.0

  • BREAKING CHANGE: Remove Floating/Fractional instances for Pattern and Shell
  • BREAKING CHANGE: Change behavior of Num instance for Pattern and Shell
  • Re-export (&)
  • Add asciiCI, (.||.), (.&&.), strict

1.0.2

  • Add fp format specifier
  • Add chars/chars high-efficiency parsing primitives
  • Fix bugs in path handling

1.0.1

  • Generalize type of die
  • Fix doctest

1.0.0

  • Initial release