https://github.com/alexpeits/harg

Haskell program configuration using higher kinded data
https://github.com/alexpeits/harg

configuration haskell option-parser optparse-applicative

Last synced: about 2 months ago
JSON representation

Haskell program configuration using higher kinded data

• Host: GitHub
• URL: https://github.com/alexpeits/harg
• Owner: alexpeits
• License: bsd-3-clause
• Created: 2019-06-23T21:11:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T16:16:29.000Z (7 months ago)
• Last Synced: 2024-10-15T19:04:34.729Z (2 months ago)
• Topics: configuration, haskell, option-parser, optparse-applicative
• Language: Haskell
• Homepage: https://hackage.haskell.org/package/harg
• Size: 355 KB
• Stars: 29
• Watchers: 3
• Forks: 4
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# harg :nut_and_bolt:

[![Build Status](https://github.com/alexpeits/harg/workflows/Build%20and%20test/badge.svg)](https://github.com/alexpeits/harg/actions)

[![Hackage](https://img.shields.io/hackage/v/harg.svg)](https://hackage.haskell.org/package/harg)

`harg` is a library for configuring programs by scanning command line arguments,

environment variables, default values and more. Under the hood, it uses a subset

of [`optparse-applicative`](https://hackage.haskell.org/package/optparse-applicative)

to expose regular arguments, switch arguments and subcommands. The library

relies heavily on the use of higher kinded data (HKD) thanks to the

[`barbies`](https://hackage.haskell.org/package/barbies) library. Using

[`higgledy`](https://hackage.haskell.org/package/higgledy) also helps reduce

boilerplate code significantly.

## Documentation

To find out more, check out the [docs](https://alexpeits.github.io/harg) or the

package page on [hackage](https://hackage.haskell.org/package/harg). There is

also an [example](https://github.com/alexpeits/harg/blob/master/Example.hs)

module that serves as an extensive demonstration of the library.

## Roadmap

- Better errors using `optparse-applicative`'s internals

- Allow user to pass `optparse-applicative` preferences

- Write tests

## Credits

- [jcpetruzza](https://github.com/jcpetruzza)

- [i-am-tom](https://github.com/i-am-tom)

- [jmackie](https://github.com/jmackie)