Commands

A command-line interface for managing and working with Cooklang recipes.

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

macOS (Homebrew)

brew install cookcli

Build from Source

git clone https://github.com/cooklang/cookcli.git
cd cookcli
cargo build --release

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 &#34;Neapolitan Pizza&#34;                # View a recipe
cook shopping-list &#34;Neapolitan Pizza&#34; &#34;Easy Pancakes&#34;  # Shopping list
cook server --open                            # Browse in browser

For the Cooklang markup language, see the language specification.

Recipe

Parse and display Cooklang recipe files.

Usage

cook recipe [OPTIONS] [RECIPE]

Arguments

Argument	Description …

Shopping List

Generate a combined shopping list from one or more recipes.

Usage

cook shopping-list [OPTIONS] [RECIPES]...

Arguments …

Server

Start a local web server to browse and view your recipe collection.

Usage

cook server [OPTIONS] [BASE_PATH]

Arguments …

Search

Search through your recipe collection for matching text.

Usage

cook search [OPTIONS] &lt;TERMS&gt;...

Arguments …

Import

Import recipes from websites and convert to Cooklang format.

Requires the OPENAI_API_KEY environment variable for conversion to Cooklang. Without the …

Doctor

Analyze your recipe collection for issues and improvements.

Usage

cook doctor [OPTIONS] [COMMAND]

Subcommands

`validate`

Validate all recipes for …

Seed

Initialize a directory with example Cooklang recipes.

Usage

cook seed [OPTIONS] [DIR]

Arguments

Argument …

Report

Generate custom reports from recipes using templates.

Note: The report command is currently a prototype feature.

Usage

cook report [OPTIONS] …

Update

Update CookCLI to the latest version.

Usage

cook update [OPTIONS]

Alias: cook u

Options

Option	Description …

Lsp

Start the Language Server Protocol server for Cooklang editor integration.

Usage

cook lsp [OPTIONS]

The server communicates over stdin/stdout. …

Pantry

Manage and analyze your pantry inventory.

Usage

cook pantry [OPTIONS] &lt;COMMAND&gt;

Options

Option …