For AI agents: the complete documentation index is available at /llms.txt, the full documentation bundle is available at /llms-full.txt, and this page is available as Markdown at /cli/alias/start.md.
  • English
  • Quick Start

    Write your first alias file in three minutes.

    Getting Started

    Create a Config File

    Create run.byk.json in your project root:

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

    Run It Directly

    byk dev
    byk build
    byk deploy            # interactive: asks for env first, confirms, then runs

    *.byk.json files in the current directory are merged in by default at priority 1 (the global directory is 0). So short names work the moment you enter the directory, and project aliases override global ones with the same name — that is "near-first".

    Keep It Out of the Directory

    Some files belong to a single script and shouldn't show up under byk <key>. Add $private: true:

    run.byk.json
    {
      "$private": true,
      "dev": "pnpm dev"
    }
    byk dev            # not found
    byk @run.dev       # exact invocation — the only way to call it

    Make It Available in Your Home Directory

    byk @@run..clone @run     # copy ./run.byk.json into ~/.byk/alias/
    byk dev

    A plain cp run.byk.json ~/.byk/alias/ works too. Files under ~/.byk/alias/ default to priority 0 and are available in any directory; when you enter a project with a same-named alias, the project's copy overrides it.

    Going Further