Setup

Install

One-liner install, then key, then velox. Swap in the real installer URL when you publish it; the patterns below are what users expect to copy-paste.

Try velox fix first

npx velox fix

No setup required. Run directly in your project directory.

Fastest path (curl)

curl -fsSL https://example.com/install.sh | sh   # replace with your release URL

Homebrew

brew install veloxcli

npm

npm install -g veloxcli
  1. Install the client

    If you skipped the one-liners above: download a release archive for your OS and architecture from GitHub Releases, extract, and place the binary on your PATH.

    # Homebrew (macOS / Linux where available)
brew install veloxcli

# npm (global CLI package name may differ by release)
npm install -g veloxcli

    Full download links and checksums live in the GitHub repository.

  2. Set your API key

    Groq requires an API key for inference. Export it in the shell or set it in your config file. Environment variables override file defaults, which suits CI.

    export GROQ_API_KEY="your_key_here"
  3. Run

    Start the TUI, run a one-shot print request, or add context paths from the CLI.

    velox              # interactive TUI
velox -p "prompt"  # print mode: stdout, CI-friendly
# JSONL / structured streams: see docs for current flags (e.g. automation pipelines)
velox --add ./src  # example: attach a directory (see docs for current flags)

    Extended options, configuration keys, and troubleshooting are covered in the project documentation linked from the repository README.

Feature reference · Source on GitHub