CLI Overview
3 min
min

CLI Overview

Overview

The Solsta Command Line Interface (CLI) lets you access core Solsta functionality - such as installing, updating, and launching - directly from your terminal. It integrates with agentic tools and organizational systems, enabling you to automate and streamline your workflows.

The steps in this article assume you've accepted your invitation to Solsta or created your own account.

Supported Platforms
  • Windows 10+
  • macOS 12+
  • Ubuntu 22+

Quickstart

Step 1: Download the CLI

Download the Solsta CLI at solsta.io/download

On macOS or Ubuntu, grant execute permissions before running:

chmod +x /path/to/solsta_cli

Step 2: Sign in

Option 1: Log in as a user

Type this into your terminal: 

solsta_cli login prompt

This opens a login prompt in a browser just like the Solsta Desktop Application (GUI)


Option 2: Login with Machine Credentials

Generate M2M Credentials in the Solsta Desktop Application first. These credentials are meant for unmanned machines or processes that do not allow login via a browser.

Type this into your terminal: 

solsta_cli login client_credentials \  --client_id=YOUR_CLIENT_ID \  --client_secret=YOUR_CLIENT_SECRET

Note: M2M tokens expire after 24 hours. User tokens stay active as long as the CLI is used at least once every 30 days.

Step 3: See what's available

List the products and environments your account has access to. These commands give you the exact names needed for install. Names are case-sensitive.

solsta_cli product read
solsta_cli env read --product_name=YourProductName

Sample output: 

START - ProductRead
STOP
  Body:
    Items:      
      - Name: League of Llamas
        CreatedTime: 1689901767
        Org: org_33GWK07mAY8cFJuO
        ModifiedTime: 1771381201
        Product: 61dbaa6d-a354-4262-be9f-29f17bfc0520
        DeletionProtection: false
        Description: Multi-llama online battle arena
        Permissions:
          - CreateEnvironment
          - DeleteProduct
          - UpdateProduct
          - UpdateProductMembers
  HttpCode: 200
  ElapsedTime: 1.43034399999
  ExitCode: 0


Once you have your product and environment names, head to Using the Solsta CLI to continue.


CLI and GUI

The Solsta CLI and Desktop Application are designed to coexist on the same machine. The GUI will not reflect CLI changes in real time. Restart the GUI to see updates made by the CLI.

Known Issues

A terminal error does not release a session slot from the Orchestration Service. This causes a retry of the same download on the same machine to be delayed by 10 minutes.