For AI agents: the complete documentation index is available at /zh/llms.txt, the full documentation bundle is available at /zh/llms-full.txt, and this page is available as Markdown at /zh/cli/alias/start.md.
  • 简体中文
  • 快速开始

    三分钟写出第一个别名文件。

    快速入门

    创建配置文件

    在项目根目录创建 run.byk.json:

    {
      "dev": "pnpm dev",
      "build": "pnpm build",
      "deploy": {
        "$cmd": "deploy --env {env}",
        "$mode": "interactive"
      }
    }

    直接执行

    byk dev
    byk build
    byk deploy            # 交互:先问 env,确认后再执行

    当前目录里的 *.byk.json 默认参与合并、优先级 1(全局目录是 0)。所以进目录就能用短名字调用,同名时项目里的覆盖全局的——这就是「就近优先」。

    不想让它在目录里生效

    有些文件只属于某个脚本,不该出现在 byk <key> 里。写一行 $private: true:

    run.byk.json
    {
      "$private": true,
      "dev": "pnpm dev"
    }
    byk dev            # 找不到
    byk @run.dev       # 精确调用,只能这样用

    想让它在家目录也能用

    byk @@run..clone @run     # 把当前目录的 run.byk.json 复制到 ~/.byk/alias/
    byk dev

    也可以直接 cp run.byk.json ~/.byk/alias/。~/.byk/alias/ 下的文件默认优先级 0,在任何目录都可用;进入含有同名别名的项目时,项目里的那份会覆盖它。

    进阶