命令行概览
clice 只有一个二进制。编辑器启动 clice serve 并通过 LSP 与它通信;其余子命令在终端里驱动同一个引擎,共用它的编译数据库处理、缓存和索引。
| 命令 | 作用 | 页面 |
|---|---|---|
serve | 启动语言服务器。编辑器会替你启动,见编辑器设置。 | editors |
lint | 用 worker 池对每个翻译单元运行 clang-tidy。 | lint |
index | 提前为项目建立索引,让服务器热启动。 | index |
format | 用 clang-format 格式化项目中的文件。 | format |
inspect | 对一个源文件运行某一项功能,把原始结果打印成 JSON。 | |
command | 显示一个文件编译时所用的命令,并为其他工具转换编译命令。 | command |
query | 向持久化索引查询符号、引用、调用图和文件。 | query |
refactor | 依据持久化索引在整个项目中重命名一个符号。 | refactor |
analyze | 报告重构所需的事实,例如模块依赖和循环依赖。 | analyze |
modularize | 把第三方库封装成 C++20 模块,把程序改写成模块单元。 | modularize |
scan | 扫描构建的 include 和模块依赖,并为扫描计时。 | scan |
inspect 现在已可使用但还没有页面,它的操作和选项通过 clice inspect --help 查看。
参数
每个子命令都以同样的方式接受参数:
clice <command> [<operation>] [<target>...] [--option...]- 能做几件事的命令,用紧跟其后的一个词指明要做哪一件:
clice query references、clice index stats、clice analyze modules edge。有一项首要职能的命令,后面不跟词时就执行这项职能:clice index建立索引,clice analyze modules给出概览,clice command <file>显示该文件的编译命令。在任何命令或操作后面加上--help,都会列出它接受的参数。 - 目标,即操作所针对的符号或文件,跟在操作之后:
clice query references "shapes::Circle::area"、clice query document-symbols src/main.cpp。凡是接受符号的地方,都用定位串(locator)指明符号;文件则用路径指明,可以相对于当前目录,也可以是绝对路径;命令行上的其他路径也都如此,例如分区文件或输出目录。 - 选项放在操作之后。一个选项要取多个值时,就重复给出它:
--scope 'src/**' --scope 'include/**'。 --workspace <dir>指定项目根目录;不给出时,命令作用于当前目录所在的项目,查找方式与 git 查找仓库相同:从当前目录向上,最近的一个含有clice.toml、.clice/config.toml或compile_commands.json的目录(直接含有,或在其build/目录中含有),一个都找不到时就是当前目录本身(inspect与编辑器一样,从文件所在位置向上查找)。命令无法接受的配置——无法解析的文件、类型错误的值、无法遵照的选项——会使命令以退出码 2 失败,每个问题都连同它在文件中的位置一起给出;--configuration <tag>固定构建配置,其优先级高于编辑器持久化的选择(参见切换配置);-j、--jobs <n>指定index、lint和format同时处理多少个单元或文件;环境变量CLICE_LOG_LEVEL设置向 stderr 输出哪些日志,默认为警告和错误(编辑器会显示serve的 stderr,它从info级别起输出);无论该变量取什么值,serve、index和lint的会话日志都保留info级别。
退出码
每个命令都以下面四种退出码之一结束,各命令的页面会详细说明:
| 退出码 | 含义 |
|---|---|
0 | 命令完成了所要求的事。 |
1 | 命令完成了,但答案是否定的:Lint 发现了问题、有文件需要格式化、找不到符号或文件、重命名有冲突、有翻译单元索引失败。 |
2 | 命令无法完成:参数或配置无法解析、没有可处理的对象(没有项目、没有编译数据库、没有翻译单元)、无法打开索引。 |
130 | 命令被中断。 |
