进阶 oclif.io 2026-10-18 02:37:03 · 23 阅读
第18章 CLI 配置详解
Config 配置
在命令内部,this.config 提供了对 Config 类的访问,其中包含你在编写命令时可用的有用属性和方法。以下是其方法和属性列表:
- name - CLI 名称
- version - CLI 版本
- pjson - 解析后的 CLI package.json
- bin - CLI bin 名称
- cacheDir - CLI 缓存目录
- macOS:
~/Library/Caches/mycli - Unix:
~/.cache/mycli - Windows:
%LOCALAPPDATA%\mycli - 可通过
<CLI>_CACHE_HOME覆盖,其中<CLI>为你的 CLI 名称。 - 在 Linux 系统上,可使用
XDG_CACHE_HOME进行覆盖
- macOS:
- configDir - CLI 配置目录
- Unix:
~/.config/mycli - Windows:
%LOCALAPPDATA%\mycli - 可通过
<CLI>_CONFIG_HOME覆盖,其中<CLI>为你的 CLI 名称。 - 在 Linux 系统上,可使用
XDG_CONFIG_HOME进行覆盖
- Unix:
- dataDir - CLI 数据目录
- Unix:
~/.data/mycli - Windows:
%LOCALAPPDATA%\mycli - 可通过
<CLI>_DATA_HOME覆盖,其中<CLI>为你的 CLI 名称。 - 在 Linux 系统上,可使用
XDG_DATA_HOME进行覆盖
- Unix:
- dirname - 用于 cacheDir|configDir|dataDir 的 dirname。可在 package.json 中覆盖。
- errlog - cacheDir 内错误日志的路径
- home - 用户主目录
- platform - 操作系统 darwin|linux|win32
- arch - 进程架构 x64|x86
- shell - 当前使用的 shell
- userAgent - 用于 HTTP 调用的 user-agent。示例:
mycli/1.2.3 (darwin-x64) node-9.0.0 - windows - 布尔值,判断是否为 Windows
- npmRegistry - 用于 plugins 插件的当前 npm registry
- plugins - 已加载的插件
- commands - CLI 中的所有命令
- default - 默认 CLI 命令
- topics - CLI 中的所有主题
- commandIDs - 所有命令的字符串 ID
- async runHook(event, opts) - 触发钩子
- async runCommand(id, opts) - 运行命令
- scopedEnvVar(key) - 返回作用域环境变量的值(例如
\<CLI>_NPM_REGISTRY) - scopedEnvVarKey(key) - 返回作用域环境变量的名称(例如
\<CLI>_NPM_REGISTRY) - scopedEnvVarTrue(key) - 返回作用域环境变量的 true/false 值(例如
\<CLI>_NPM_REGISTRY)
自定义用户配置
为用户提供自定义配置通常很有用。实现方式之一是从 CLI 的配置目录读取 config.json 文件:
import { Command } from "@oclif/core";
import * as fs from "fs-extra";
import * as path from "path";
export class extends Command {
async run() {
const userConfig = await fs.readJSON(
path.join(this.config.configDir, "config.json")
);
this.log("User config:");
console.dir(userConfig);
}
}