编译构建、测试与运行诊断命令 · 生成文档、整理上下文与分享代码图至专用开发环境

返回分篇目录

生成文档、整理上下文与分享代码图

按语言生成 API 文档，用 yek 整理代码上下文，carbon-now 生成代码图。

javadoc · 从源代码以 HTML 格式生成 Java API 文档

更多信息：https://docs.oracle.com/en/java/javase/25/docs/specs/man/javadoc.html。

• 生成 Java 源代码的文档并将结果保存在文件夹中：

javadoc -d {{path/to/directory}}/ {{path/to/java_source_code}}

• 生成指定编码的文档：

javadoc -docencoding {{UTF-8}} {{path/to/java_source_code}}

• 生成文档时，排除掉某些软件包：

javadoc -exclude {{package_list}} {{path/to/java_source_code}}

rustdoc · 为 Rust 包（crate）生成文档

更多信息：https://doc.rust-lang.org/stable/rustdoc/。

• 从包（crate）的根文件生成文档：

rustdoc {{src/lib.rs}}

• 为项目传递一个名称：

rustdoc {{src/lib.rs}} --crate-name {{名称}}

• 从 Markdown 文件生成文档：

rustdoc {{路径/到/文件.md}}

• 指定输出目录：

rustdoc {{src/lib.rs}} {{[-o|--out-dir]}} {{路径/到/输出目录}}

• 显示帮助：

rustdoc {{[-h|--help]}}

yard · Ruby 的文档工具

更多信息：https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#using-yard-to-generate-documentation。

• 创建文档：

yard

• 创建文档并保存到一个文件中：

yard --one-file

• 列出所有未记录的对象：

yard stats --list-undoc

yek · 将一个代码仓库或目录序列化为适合 LLM 使用的单个文件（基于 Rust 的快速 repomapper 工具）

更多信息：https://github.com/bodo-run/yek#usage。

• 序列化当前目录并将输出写入临时文件（打印文件路径）：

yek

• 序列化指定目录并将输出写入目标目录：

yek {{路径/到/目录1 路径/到/目录2 ...}} --output-dir {{路径/到/输出目录}}

• 处理多个文件或使用通配符模式（请用引号包裹通配符，以避免 shell 展开）：

yek "{{路径/到/目录/**/*.rs}}" "{{路径/到/目录/**/*.md}}"

• 将基于 token 的输出大小限制为 128k tokens：

yek {{路径/到/目录}} --tokens 128k

• 以字节为单位限制最大输出大小，并显式指定输出文件名：

yek {{路径/到/目录}} --max-size {{100KB}} --output-name {{yek-output.txt}}

• 以流式 JSON 格式输出：

yek {{路径/到/目录}} --json

• 在输出中包含目录树结构头部：

yek {{路径/到/目录}} --tree-header

carbon-now · 创建漂亮的代码图片

更多信息：https://github.com/mixn/carbon-now-cli。

• 使用默认设置从文件创建图片：

carbon-now {{文件}}

• 使用默认设置从剪贴板创建图片：

carbon-now --from-clipboard

• 使用默认设置从标准输入创建图片：

{{输入}} | carbon-now

• 以交互方式创建图片以进行自定义设置，还可以选择保存预设：

carbon-now -i {{文件}}

• 从先前保存的预设创建图片：

carbon-now -p {{预设}} {{文件}}

• 从指定的文本行开始：

carbon-now -s {{行号}} {{文件}}

• 结束于指定的文本行：

carbon-now -e {{行号}} {{文件}}

• 在浏览器中打开图片而不是保存：

carbon-now --open {{文件}}

证书自动化与数值计算

acme.sh 管理证书，bc 进行数值计算，作为本页保留的辅助工具。

acme.sh · 实现了 ACME 客户端协议的 shell 脚本，是 certbot 的替代品

另请参阅：acme.sh dns。 更多信息：https://github.com/acmesh-official/acme.sh#2-just-issue-a-cert。

• 使用网站根目录模式签发证书：

acme.sh --issue {{[-d|--domain]}} {{example.com}} {{[-w|--webroot]}} /{{路径/到/网站根目录}}

• 使用独立模式和 80 端口为多个域名签发证书：

acme.sh --issue --standalone {{[-d|--domain]}} {{example.com}} {{[-d|--domain]}} {{www.example.com}}

• 使用独立 TLS 模式和 443 端口签发证书：

acme.sh --issue --alpn {{[-d|--domain]}} {{example.com}}

• 使用运行中的 nginx 的配置来签发证书：

acme.sh --issue --nginx {{[-d|--domain]}} {{example.com}}

• 使用运行中的 Apache 的配置来签发证书：

acme.sh --issue --apache {{[-d|--domain]}} {{example.com}}

• 使用自动 DNS API 模式签发一个通配符（*）证书：

acme.sh --issue --dns {{dns_cf}} {{[-d|--domain]}} {{*.example.com}}

• 将证书文件安装到指定位置（对自动更新证书很有用）：

acme.sh {{[-i|--install-cert]}} {{[-d|--domain]}} {{example.com}} --key-file /{{路径/到/example.com.key}} --fullchain-file /{{路径/到/example.com.cer}} --reloadcmd "{{systemctl force-reload nginx}}"

bc · 任意精度的计算器语言

另请参阅：dc, qalc。 更多信息：https://manned.org/bc。

• 启动交互式会话：

bc

• 启动交互式会话并启用标准数学库：

bc {{[-i|--interactive]}} {{[-l|--mathlib]}}

• 计算表达式：

echo '{{5 / 3}}' | bc

• 执行脚本：

bc {{路径/到/脚本.bc}}

• 使用指定的小数位数计算一个表达式：

echo 'scale = {{10}}; {{5 / 3}}' | bc

• 使用 mathlib 计算正弦/余弦/反正切/自然对数/指数函数：

echo '{{s|c|a|l|e}}({{1}})' | bc {{[-l|--mathlib]}}

• 执行一个内联的阶乘脚本：

echo "define factorial(n) { if (n <= 1) return 1; return n*factorial(n-1); }; factorial({{10}})" | bc

专用开发环境

u3d · 一组用于与 Unity 进行交互的工具

更多信息：https://github.com/DragonBox/u3d。

• 使用正确的 Unity 版本打开当前目录中的项目：

u3d

• 列出已安装的 Unity 版本：

u3d list

• 列出可下载的 Unity 版本：

u3d available

• 下载并安装最新的稳定 Unity 版本：

u3d install latest_stable

• 下载并安装指定的 Unity 版本和编辑器包：

u3d install {{2021.2.0f1}} -p {{Unity,iOS,Android}}

---

示例整理自 tldr-pages，作者为 tldr-pages team and contributors，遵循 CC BY 4.0。