Skip to content

Latest commit

 

History

History

README.md

CookCLI

CookCLI is a free, open-source command-line tool for working with Cooklang recipe files. It parses .cook files, generates combined shopping lists from multiple recipes, runs a local web server to browse your collection, imports recipes from websites, and scales servings — all from the terminal.

Commands

Command Alias Description
recipe r Parse, validate and display recipe files
shopping-list sl Generate a combined shopping list from recipes
server s Start a web server to browse recipes
search f Search through your recipe collection
import i Import recipes from websites
report rp Generate custom reports using templates
doctor Analyze recipes for issues
pantry p Manage and analyze pantry inventory
seed Initialize with example recipes
lsp Start the Language Server Protocol server
update u Update CookCLI to the latest version

Installation

Download Binary

Download the latest release for your platform from the releases page and add it to your PATH.

macOS/Linux

Using Homebrew:

brew install cookcli

Install with Cargo

If you have Rust installed:

cargo install cookcli

Global Options

Option Description
-v, --verbose... Increase verbosity (-v info, -vv debug, -vvv trace)
-h, --help Print help
-V, --version Print version

Quick Start

cook seed                                     # Create example recipes
cook recipe "Neapolitan Pizza"                # View a recipe
cook shopping-list "Neapolitan Pizza" "Easy Pancakes"  # Shopping list
cook server --open                            # Browse in browser

For the Cooklang markup language, see the language specification.