Skip to content

Commit 8946d02

Browse files
committed
docs: update
1 parent 4ce7af4 commit 8946d02

2 files changed

Lines changed: 49 additions & 6 deletions

File tree

docs/README.md

Lines changed: 47 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# CookCLI Documentation
2-
31
The Cook CLI command line program provides a suite of tools to create shopping lists, maintain recipes, and manage your cooking workflow. We've built it to be simple and useful for automating your cooking and shopping routine with existing UNIX command line and scripting tools.
42

53
## Available Commands
@@ -27,6 +25,44 @@ cd cookcli
2725
cargo build --release
2826
```
2927

28+
## Global Options
29+
30+
CookCLI supports several global options that apply to all commands:
31+
32+
### Base Path
33+
Specify the directory containing your recipes (defaults to current directory):
34+
35+
```bash
36+
# Use recipes from a specific directory
37+
cook --base-path ~/my-recipes recipe "Pizza.cook"
38+
39+
# Short form
40+
cook -b ~/my-recipes shopping-list "Pasta.cook"
41+
```
42+
43+
### Logging Verbosity
44+
Control the amount of debug information displayed:
45+
46+
```bash
47+
# Normal output (default)
48+
cook recipe "Pizza.cook"
49+
50+
# Info level logging (-v)
51+
cook -v recipe "Pizza.cook"
52+
53+
# Debug level logging (-vv)
54+
cook -vv shopping-list "Pasta.cook"
55+
56+
# Trace level logging (-vvv) - most verbose
57+
cook -vvv doctor validate
58+
```
59+
60+
The logging levels are:
61+
* No flag: Normal output only
62+
* `-v`: Info messages
63+
* `-vv`: Debug messages (helpful for troubleshooting)
64+
* `-vvv`: Trace messages (detailed parsing and processing information)
65+
3066
## Quick Start
3167

3268
Start by creating some sample recipes to explore:
@@ -43,6 +79,9 @@ cook shopping-list "Neapolitan Pizza.cook" "Caesar Salad.cook"
4379

4480
# Start the web server
4581
cook server
82+
83+
# Use recipes from another directory with debug logging
84+
cook -b ~/recipes -vv server
4685
```
4786

4887
## Philosophy
@@ -59,9 +98,11 @@ Everything in CookCLI follows these principles:
5998
Recipes are stored as `.cook` files using the Cooklang markup language. Here's a simple example:
6099

61100
```cooklang
62-
>> title: Simple Pasta
63-
>> time: 20 minutes
64-
>> servings: 2
101+
---
102+
title: Simple Pasta
103+
time: 20 minutes
104+
servings: 2
105+
---
65106
66107
Bring @water{2%liters} to a boil in a large #pot.
67108
@@ -147,4 +188,4 @@ cook shopping-list --help
147188

148189
## License
149190

150-
CookCLI is open source software licensed under the [MIT License](https://github.com/cooklang/cookcli/blob/main/LICENSE).
191+
CookCLI is open source software licensed under the [MIT License](https://github.com/cooklang/cookcli/blob/main/LICENSE).

docs/import.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ The `import` command fetches recipes from websites and automatically converts th
44

55
Requires `OPENAI_API_KEY` environment variable set to perform the conversion to Cooklang. Without the key you still can downlad recipe original content, but it won't be converted to Cooklang.
66

7+
Note that you can use [cook.md converter](https://cooklang.org/docs/getting-started#build-your-recipe-collection) if you don't have OpenAI key.
8+
79
## Basic Usage
810

911
```bash

0 commit comments

Comments
 (0)