import { Steps } from '@rspress/core/theme';

# 快速开始

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

## 快速入门

<Steps>
  ### 创建配置文件

  在项目根目录创建 `run.byk.json`：

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

  ### 直接执行

  ```bash
  byk dev
  byk build
  byk deploy            # 交互：先问 env，确认后再执行
  ```

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

  ### 不想让它在目录里生效

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

  ```json title="run.byk.json"
  {
    "$private": true,
    "dev": "pnpm dev"
  }
  ```

  ```bash
  byk dev            # 找不到
  byk @run.dev       # 精确调用，只能这样用
  ```

  ### 想让它在家目录也能用

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

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

  ### 进阶

  * [别名配置](/zh/cli/alias/config.md) — 字段、继承、优先级、精确执行
  * [参数处理](/zh/cli/alias/placeholders.md) — 占位符与参数消耗规则
  * [选项与命令](/zh/cli/commands.md) — `-h` / `-v` / `--paths` / `--check`
  * [文件命令](/zh/cli/file-commands.md) — 直接改别名文件本身的一组保留命令
  * [程序接口](/zh/cli/api.md) — 写脚本或插件时用的 `byk __api__`
</Steps>

***

byk v0.8.2 · 本页可能落后于 HEAD，以 `byk __api__` 与 `byk -v` 为准。
