# Install the Starplex CLI

<p class="lede">The Starplex CLI connects your coding agents to Starplex. One command installs it for your user account. It doesn't need administrator access.</p>



## Before you start


<ul class="needs">
<li><b>macOS or Linux</b>with a shell such as bash or zsh</li>
<li><b>Node.js 26 or later</b>with npm, on your <code>PATH</code></li>
<li><b>An invitation</b>to a Starplex organization, to sign in afterward</li>
</ul>



## Install


<ol class="steps">
<li>
<h3>Run the installer</h3>
<p>Paste this into your terminal. It downloads the CLI from Starplex and puts the <code>starplex</code> command in <code>~/.local/bin</code>.</p>


```sh frame="terminal"
curl -fsSL https://app.starplex.dev/install.sh | sh
```


<div class="result"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><circle cx="12" cy="12" r="9"></circle><path d="m8 12 3 3 5-6"></path></svg><span>It's done when the last line reads <strong>Starplex CLI installation finished</strong>, followed by the build and where it put the command.</span></div>
<details class="trouble"><summary><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" aria-hidden="true"><path d="M12 9v4M12 17h.01"></path><path d="M10.3 3.9 2.4 18a2 2 0 0 0 1.7 3h15.8a2 2 0 0 0 1.7-3L13.7 3.9a2 2 0 0 0-3.4 0Z"></path></svg>It says Node 26 or later is required</summary><div class="body"><p>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.</p></div></details>
</li>
<li>
<h3>Check the command is on your PATH</h3>
<p>Check that your shell can find the command:</p>


```sh frame="terminal"
starplex --version
```


<div class="result"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><circle cx="12" cy="12" r="9"></circle><path d="m8 12 3 3 5-6"></path></svg><span>You'll see one line naming the CLI's version and the build that was installed.</span></div>
<details class="trouble" open=""><summary><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" aria-hidden="true"><path d="M12 9v4M12 17h.01"></path><path d="M10.3 3.9 2.4 18a2 2 0 0 0 1.7 3h15.8a2 2 0 0 0 1.7-3L13.7 3.9a2 2 0 0 0-3.4 0Z"></path></svg>command not found: starplex</summary><div class="body"><p>The installer prints this fix when <code>~/.local/bin</code> isn't on your <code>PATH</code>. Add this line to your shell profile, such as <code>~/.zshrc</code>, then open a new terminal:</p>


```sh frame="terminal" title="~/.zshrc"
export PATH="$HOME/.local/bin:$PATH"
```

</div></details>
</li>
</ol>

<div class="note"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" aria-hidden="true"><circle cx="12" cy="12" r="9"></circle><path d="M12 11v5M12 8h.01"></path></svg><p><strong>Updates are automatic.</strong> The CLI keeps itself on the build the Starplex server runs, so you don't need to run the installer again.</p></div>
