DocumentationInstallation

Installation

Get the BuildStax binary onto your path, verify the build, and choose how you want to work.

03 sections6 min readUpdated for preview
On this page
  1. 01Get the CLI
  2. 02Verify the install
  3. 03Choose an interface
01

Get the CLI

BuildStax is not currently published as an npm CLI. Use the platform build supplied with your access and place the buildstax executable on your system path.

  • A terminal with Git available
  • A repository you can modify
  • An API key for a supported model provider
02

Verify the install

Both commands should resolve without a path error. The help output is the source of truth for options supported by your installed build.

Command
buildstax --version
buildstax --help
03

Choose an interface

Use a one-shot query for a focused task, launch buildstax with no arguments for the interactive REPL, or open the full-screen terminal interface.

Command
buildstax "explain the test strategy in this repository"
buildstax
buildstax tui