Skip to content
Starplex Docs

Get started · Step 2 of 3

Sign in to Starplex

Sign in on your machine so your coding agents can reach Starplex. You'll choose which organizations that sign-in covers.

Install the CLI and accept an invitation to a Starplex organization. Use the account that received the invitation.

  1. Start sign-in from your terminal

    Terminal window
    starplex login --server https://app.starplex.dev

    The CLI prints a sign-in address and tries to open your browser. If it doesn't open, follow the printed address yourself.

    On a remote machine, such as one reached over SSH, the browser can't open by itself; after you approve access, it ends on a page that fails to load, so copy that page's full address and paste it at the terminal's prompt. On your own machine, the CLI finishes by itself.

    Keep this terminal open while you finish in the browser.

  2. Choose your organizations in the browser

    Sign in, then approve access to the organizations you want to use. Your consent covers each whole organization. Choosing a project later does not narrow that access.

    Return to the terminal. A successful result reports your sign-in and organization coverage.

    Your organization isn't listed

    Check that you accepted its invitation and signed in with the invited account. Ask the person who invited you if you still can't see it.

Terminal window
starplex auth-check

A successful check reports a state of locally_ready for the selected connection. It reads only your machine, so the server’s acceptance is reported as unknown; the agent’s project read on the Connect page proves the server side. If it reports that you aren’t signed in, run the login command again and finish the browser step.

Your credentials stay on your machine. Connecting a repository writes relay configuration, not credentials, into the project.