Quick Start
Write your first alias file in three minutes.
Getting Started
Create a Config File
Create run.byk.json in your project root:
Run It Directly
*.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
Make It Available in Your Home Directory
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
- Alias Configuration — fields, inheritance, priority, exact execution
- Placeholders — placeholder syntax and argument consumption rules
- Options & Commands —
-h/-v/--paths/--check - File Commands — the built-in commands that edit an alias file itself
- Program Interface —
byk __api__, for scripts and plugins