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 /index.md.
  • English
  • v0.8.2·MIT·Rust

    byk

    A CLI that only runs aliases

    Write commands into *.byk.json, and call them by short names

    $pip install byk
    ~ — byk
    $ byk @@hi..init
    Created ~/.byk/alias/hi.byk.json
    
    $ byk @@hi..set hello --cmd "echo hello world"
    Set hello in ~/.byk/alias/hi.byk.json
    
    $ byk hello
    hello world
    Core

    Write JSON, run short commands

    One file holds every command in your project — no full paths or arguments to memorize

    Command Aliases

    The global file, without an editor

    In a project the file is easiest to write by hand; for ~/.byk/alias/, file commands finish it in four lines.

    terminal · a file in four commands

    terminal
    $ byk @@ops..init
    
    $ byk @@ops..set clean --cmd "cargo clean"
    
    $ byk @@ops..set serve --cmd "cargo run --release"
    
    $ byk @@ops..set deploy --cmd "deploy --env {env}" \
        --mode interactive

    config · ~/.byk/alias/ops.byk.json

    ops.byk.json
    {
    "clean": "cargo clean",
    "deploy": {
    "$cmd": "deploy --env {env}",
    "$mode": "interactive"
    }
    "serve": "cargo run --release"
    }
    CLI Surface

    Four options and a set of file commands

    Besides aliases, this is all byk has.

    Help

    byk -h

    Banner, usage, options, and every alias at a glance; running bare is equivalent

    Version

    byk -v

    Version, commit, build date, platform, and install location

    Paths

    byk --paths

    The actual locations of the CLI home and global alias directory

    Check

    byk --check

    Scan every alias file and report read, JSON, metadata, and link problems per file

    File Commands

    byk @@ops..help

    Built into every alias file: init, set, remove, clone, link, json, path

    Program Interface

    byk __api__

    Read-only and never writes to disk: feeds data to shell completion and editor plugins

    Why byk

    One entry point for every command

    01Predictable sources

    Options → hidden interface → file commands → @file.key → aliases — first match wins; on a miss, candidates are listed and it exits 1.

    02Clear scoping

    Near-first: project files (1) override global files (0), so short names work as soon as you cd in; to limit a file to itself, set $private.

    03Cross-platform

    A single Rust binary with native support for macOS / Linux / Windows (x86_64 / arm64).

    04Editor integration

    Install the byk VS Code extension to run the alias under your cursor inside *.byk.json with a right-click — same experience as package.json scripts — and search all aliases from the command palette.

    byk

    Install in seconds and turn everyday commands into short names