herms: A command-line manager for delicious kitchen recipes

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain]

HeRM's: a Haskell-based Recipe Manager for delicious kitchen recipes


[Skip to ReadMe]

Properties

Versions1.8.1.2, 1.8.1.3, 1.8.1.4, 1.8.2.1, 1.8.2.1, 1.8.2.2, 1.9.0.0, 1.9.0.2, 1.9.0.3, 1.9.0.4
Change logchangelog
Dependenciesansi-terminal (>=0.7.0 && <=0.8.1), base (>=4.8 && <5), brick (==0.35.*), directory (>=0.0), microlens (==0.4.*), microlens-th (==0.4.*), optparse-applicative (==0.14.*), semigroups (>=0.18.3 && <=0.18.4), split (==0.2.*), vty (==5.21.*) [details]
LicenseGPL-3.0-only
AuthorJack Kiefer
Maintainerjack.c.kiefer@gmail.com
CategoryCulinary, CLI, Command Line Tool
Home pagehttps://github.com/JackKiefer/herms
Source repositoryhead: git clone https://github.com/JackKiefer/herms
Executablesherms
UploadedWed Mar 21 22:22:40 UTC 2018 by JackKiefer

Downloads

Maintainers' corner

For package maintainers and hackage trustees


Readme for herms-1.8.2.1

[back to package description]

Herm's

Travis build

HeRM's: a Haskell-based Recipe Manager (yes, food recipes) for the command line.

Herm&#39;s Interface

Features

What's new:

Installation

PATH setup

Firstly, make sure that the following is added to your PATH:

~/.cabal/bin

Download and install

At the moment, Herm's can only be compiled from source, but binaries are in the works!

Manually cloning and installing from source with Stack (recommended):
git clone https://github.com/JackKiefer/herms
cd herms
stack update
stack install
Via Hackage and Cabal:
cabal update
cabal install herms
Manually with Cabal:

Your milage may vary with dependency resolution

git clone https://github.com/JackKiefer/herms
cd herms
cabal update
cabal install -j

Usage

Command-line interface

Herm's has a pretty intuitive interface for users familiar with other command-line programs!

Below is the exhaustive list of all commands and their functionalities. Take a gander!

Usage:

        herms list [-g|--group] [--tags TAGS]           list recipes
                   [--name-only ]
 
        herms add                                       add a new recipe (interactively)

        herms edit RECIPE_NAME                          edit a recipe

        herms import FILE_NAME                          import a recipe file

        herms remove RECIPE_NAMES                       remove the particular recipes

        herms view RECIPE_NAMES [-s|--serving INT]      view the particular recipes
                                [-t|--step]
                                [-c|--convert CONV_UNIT] 

        herms shopping RECIPE_NAMES [-s|--serving INT] generate shopping list for particular recipes

        herms datadir                                  print location of recipe and config files

Available options:

        -h|--help                                      Show this help text

        -v|--version                                   Show version

        RECIPE_NAME                                    index or Recipe name

        --sort SORT_ORDER                              'tags' to sort by tags

        -s|--serving INT                               specify serving size when viewing.
                                                       E.g., 'herms view -s 2 {recipe}' for two servings

        -t|--step                                      View recipe in "one-step-at-a-time" mode
                                                       (press enter between each direction)

        -g|--group                                     group recipes by tags

        --tags TAGS                                    show recipes with particular flags

        --name-only                                    only list recipes by name

        -c|--convert CONV_UNIT                         view the recipe converted to imperial or metric
                                                       E.g., 'herms view 2 -c imperial'

Configuring Herm's and managing recipe files

Herm's stores its recipes file, recipes.herms, and configuration file, config.hs, in the same directory. Herm's keeps track of its location! Run herms datadir to see the full directory path.

config.hs is a pseudo-Haskell-source-code file with several options for configuring the behaviour of Herm's. It currently supports the following options:


In honor of Logan, Utah's greatest Breakfast & Brunch.

Herm&#39;s Inn