BYK

    内置命令

    byk 提供一组内置子命令，用于添加功能、管理插件、生成补全脚本等。运行 byk -h 或不带任何参数即可看到帮助信息。

    add

    添加插件（远程仓库 / 本地文件）或初始化内置功能（npm/pnpm/comp/cache）。

    byk add [OPTIONS] <USER/REPO[@BRANCH][/KEY] | FEATURE>

    插件 (Plugins)

    选项说明
    -f, --file <PATH>使用本地 byk.json 文件代替远程仓库
    --cdn通过 jsDelivr CDN 访问 GitHub 仓库

    插件来源支持两种模式：

    • 远程仓库：byk add user/repo 或 byk add user/repo/key — 从指定 GitHub 仓库安装。可通过 @ 指定分支：byk add user/repo@dev/key
    • 本地安装：byk add -f ./local.json my-key
    示例
    byk add user/repo/key             # 从远程仓库安装指定 key
byk add user/repo                 # 安装远程仓库 byk.json 中的第一个 key
byk add user/repo@dev/key         # 从 dev 分支安装
byk add -f ./local.json key       # 使用本地 byk.json 安装
    Tip

    首次运行 byk add 安装插件时，如果 Python venv 尚未初始化，会提示是否自动创建。

    功能 (Features)

    Feature说明
    npm初始化 npm 包管理环境，创建 ~/.byk/node-pkgs/ 目录及 ni/nu 别名
    pnpm初始化 pnpm 包管理环境，同上，但使用 pnpm 作为包管理器
    comp初始化 shell 补全（自动检测 zsh/bash），在对应 rc 文件中追加补全脚本
    cache初始化 CLI 家目录 ~/.byk/ 及缓存目录结构（alias、cache、logs、plugins）
    示例
    byk add npm       # 初始化 npm 环境
byk add comp      # 配置 shell 补全
byk add cache     # 创建家目录和缓存
    Note

    功能初始化操作是幂等的——已存在的目录或已配置的补全会被跳过，不会重复创建。

    remove

    移除已初始化的功能或卸载插件。

    byk remove <feature>
    Feature说明
    comp移除 shell 补全配置（从 .zshrc / .bashrc 中删除相关行）
    node移除 node-pkgs 环境、别名文件和缓存
    all移除所有持久化数据（~/.byk/ 和 shell 补全），需输入确认
    <plugin-key>卸载指定插件（删除脚本文件并清除命令缓存，不卸载 pip 包）
    示例
    byk remove comp        # 移除 shell 补全
byk remove node        # 移除 node-pkgs 环境
byk remove hello       # 卸载名为 hello 的插件
byk remove all         # 清除所有数据
    Note

    如果当前运行的 byk 二进制文件位于 ~/.byk/ 下（如通过 curl 脚本安装），remove all 会跳过自身所在目录，并提示手动删除。

    completion

    生成指定 shell 的补全脚本并输出到 stdout。通常由 byk add comp 自动调用，无需手动使用。

    byk completion <shell>

    支持的 shell：zsh、bash、fish。

    手动配置补全
    # zsh
source <(byk completion zsh)

# bash
source <(byk completion bash)

# fish
byk completion fish | source

    全局选项

    选项说明
    -v, --version打印版本号、构建信息及安装路径
    -h, --help打印帮助信息（含 Commands、NPM Commands、Aliases 一览）

    show

    查看系统信息、插件列表或命令来源。

    byk show [SUBCOMMAND]
    Subcommand说明
    overview总览面板：目录路径、缓存状态、补全、Node、Python
    plugins已安装插件列表及其命令和脚本
    <command-name>命令名全量路由查询（查找内置命令、插件、NPM、别名中的所有匹配）

    不带子命令时显示帮助信息。

    示例
    byk show                     # 显示帮助信息
byk show overview            # 系统总览面板
byk show plugins             # 已安装插件列表
byk show build               # 查询 "build" 命令的所有来源
    命令名查询示例
    byk show build
# 输出所有名为 "build" 的命令来源：
# Built-in / Plugin / NPM / Alias（含优先级、模板、占位符等详情）

    命令执行优先级

    当输入 byk <name> 时，byk 按以下顺序匹配命令：

    1. 内置子命令 — add、remove、completion、show
    2. 全局选项 — -v、-h
    3. 插件命令 — 通过 byk add 安装的 Python 插件
    4. NPM 命令 — 通过 byk add npm/pnpm 安装的 npm 包
    5. 精确执行语法 — @file.key（本地）/ @@file.key（全局）
    6. 别名 — 从 *.byk.json 文件中加载的别名

    匹配到第一个命中即执行，不会继续向下查找。