Skip to content
Starplex Docs

Get started · Step 1 of 3

Install the Starplex CLI

The Starplex CLI connects your coding agents to Starplex. One command installs it for your user account. It doesn't need administrator access.

  • macOS or Linuxwith a shell such as bash or zsh
  • Node.js 26 or laterwith npm, on your PATH
  • An invitationto a Starplex organization, to sign in afterward
  1. Run the installer

    Paste this into your terminal. It downloads the CLI from Starplex and puts the starplex command in ~/.local/bin.

    Terminal window
    curl -fsSL https://app.starplex.dev/install.sh | sh
    It's done when the last line reads Starplex CLI installation finished, followed by the build and where it put the command.
    It says Node 26 or later is required

    The installer checks your Node version first and changes nothing if it's too old. Install Node 26 or later with your version manager, open a new terminal, and run the installer again.

  2. Check the command is on your PATH

    Check that your shell can find the command:

    Terminal window
    starplex --version
    You'll see one line naming the CLI's version and the build that was installed.
    command not found: starplex

    The installer prints this fix when ~/.local/bin isn't on your PATH. Add this line to your shell profile, such as ~/.zshrc, then open a new terminal:

    ~/.zshrc
    export PATH="$HOME/.local/bin:$PATH"

Updates are automatic. The CLI keeps itself on the build the Starplex server runs, so you don't need to run the installer again.