Cooklang-chef 命令行工具使用指南

概述

Cooklang-chef 是一个功能强大的命令行工具，专门为使用 Cooklang 格式的食谱文件而设计。它提供了一系列实用功能，包括食谱查看、格式转换、单位换算以及本地 Web 界面等，是厨房数字化管理的得力助手。

核心功能详解

1. 食谱查看与解析

使用简单的命令即可查看食谱内容：

chef recipe Bread.cook

支持多种输出格式：

• markdown：转换为 Markdown 格式
• json：转换为 JSON 格式
• cooklang：保持原始 Cooklang 格式

2. 食谱管理

列出所有可用食谱：

chef list -l

-l 参数会显示详细列表，包括食谱是否有错误。

3. 食谱集合功能

Cooklang-chef 的集合功能允许用户：

• 在任何目录下访问食谱文件
• 设置默认集合，全局可用
• 无需频繁切换工作目录

4. 单位快速转换

内置单位转换功能：

chef convert 3 cups metric

支持多种常用厨房单位的相互转换。

5. 本地 Web 界面

启动本地 Web 服务器：

chef serve --open

特性：

• 自动在默认浏览器中打开界面
• 实时更新：编辑保存食谱文件后自动刷新页面
• 适合个人或家庭使用

注意：

• 无严格安全防护
• 无缓存机制，每次请求都会从磁盘重新读取

安装方法

通过 Cargo 安装

推荐使用 Rust 的包管理器 Cargo 进行安装：

cargo install cooklang-chef --locked

此命令会自动下载并编译 CLI 工具。

手动编译安装

步骤：

1. 安装 Rust 编译器和 Cargo（推荐使用 rustup）
2. 克隆项目仓库
3. 执行以下任一安装命令：

   # 安装完整功能
   cargo install --path .
   
   # 不安装 Web 服务功能
   cargo install --path . --no-default-features
   

4. 测试安装：

   chef help
   

5. 首次使用时建议运行交互式设置：

   chef config --setup
   

配置详解

Cooklang-chef 使用 TOML 格式的配置文件，加载顺序为：

1. 当前目录下的 .cooklang/config.toml
2. 全局默认配置文件
3. 内置默认值

配置查看

查看当前集合配置：

chef config

查看全局配置：

chef config --chef

配置文件结构

默认配置模板（只需修改需要的部分）：

# 基本设置
default_units = true             # 使用内置单位系统
warnings_as_errors = false       # 将警告视为错误
recipe_ref_check = true          # 检查食谱引用
max_depth = 10                   # 食谱引用搜索最大深度

# 扩展功能开关
[extensions]
COMPONENT_MODIFIERS = true       # 组件修饰符
COMPONENT_ALIAS = true           # 组件别名
ADVANCED_UNITS = true            # 高级单位支持
MODES = true                     # 模式支持
TEXT_STEPS = true                # 文本步骤
RANGE_VALUES = true              # 范围值
TIMER_REQUIRES_TIME = true       # 计时器需要时间
INTERMEDIATE_PREPARATIONS = true # 中间准备步骤

# 额外配置文件加载
[load] 
units = ["path/to/a/units.toml"] # 额外单位定义文件
aisle = "path/to/aisle.conf"     # 分类配置文件

# Web UI 配置
[ui.tags]
mexican = { emoji = ":taco:" }   # 标签表情符号

# 导出格式配置
[export.markdown]
tags = true                      # 显示标签
description = "blockquote"       # 描述显示方式
italic_amounts = true            # 用量斜体显示

路径说明：

• 相对路径基于 .cooklang 目录
• 未指定时会自动尝试加载 .cooklang/units.toml 和全局 units.toml

使用建议

1. 初学者：从基本功能开始，逐步尝试扩展功能
2. 高级用户：充分利用集合功能和单位转换
3. 开发者：可以自定义扩展功能满足特定需求

Cooklang-chef 通过简洁的命令行界面，为食谱管理提供了专业而灵活的解决方案，无论是个人使用还是厨房数字化管理，都是理想的选择。