StudioX CLI

Run your business on StudioX from a terminal or a script: people and roles, assistants and what they know, chat, AI usage, tokens.

For administrators and developers working with one or many StudioX installations, and for scripts and CI.

Version 1.0.0 · Oct 19, 2026

Pick the file for your computer from the list below.

All platforms and checksums

Guide

studiox lets you run your business on StudioX from a terminal or a script: you add people and set their roles, make assistants and give them documents to know, talk to them, and read what your AI use costs. It is one file with nothing to install, for macOS, Windows and Linux, and it works with the hosted StudioX and with your own installation alike.

1. Install

Download the file for your computer, then:

  • macOS: xattr -c studiox-darwin-arm64 && chmod +x studiox-darwin-arm64, rename it to studiox and move it onto your PATH (for example /usr/local/bin). The first command clears the "damaged" warning macOS shows for downloads it has not seen before.
  • Windows: unzip studiox-windows.zip, rename the exe for your machine to studiox.exe. If SmartScreen warns, choose More info → Run anyway.
  • Linux: chmod +x studiox-linux-amd64 and move it onto your PATH as studiox.

Check it: studiox version.

2. Sign in

You need a token. Either:

  • your personal API key (Studio → Profile → StudioX API Key), which can do everything you can do; or
  • a Core API token (sx_pat_…) with only the scopes you want, which you make with studiox tokens create once you are signed in with your key.

Save it for your StudioX address. The token is read from the keyboard or from a pipe — never from the command line, so it stays out of your shell history:

studiox configure --base www.studiox-ai.com
# Token (sx_pat_…, sx_svc_… or your personal API key): ••••••
echo "$STUDIOX_TOKEN" | studiox configure -p acme --base studiox.acme.example.net

configure checks the token with the server before saving it, says who it signs you in as, and makes that profile the default. The file is ~/.studiox.json, readable only by you.

studiox whoami
Profile:     default (www.studiox-ai.com)
Acts as:     you@yourcompany.com — business-admin
Credential:  personal-token, scopes read, chat
Business:    6ad4…  Your Company (primary)

More than one installation

Each -p <name> is a profile: an address and a token. studiox profiles lists them, studiox use <name> changes the default, -p <name> uses one for a single command, and studiox profile rm <name> forgets one.

--base <address> uses the profile saved for that address. A token is never sent to an address it was not saved for.

Scripts and CI

STUDIOX_BASE and STUDIOX_TOKEN override the saved profile, so a job needs no config file:

export STUDIOX_BASE=https://www.studiox-ai.com
export STUDIOX_TOKEN=sx_svc_...
studiox --json assistants

Every command takes --json and prints the server's answer as JSON. Exit codes: 0 done, 1 the server refused or could not be reached, 2 the command was typed wrong.

3. Your business

studiox business
studiox business set lockConversationsByDefault=true sessionTimeoutMinutes=480
studiox usage --from 2026-10-01 --to 2026-10-31 --timezone America/Los_Angeles

business set changes the sign-in policy (sessionTimeoutMinutes, dailyForceLogoutEnabled, dailyForceLogoutMode, dailyForceLogoutTimeOfDay, dailyForceLogoutTimezone) and whether new conversations are private (lockConversationsByDefault). usage shows what AI use cost, in total and by assistant; without dates it is the last 30 days.

If you belong to more than one business, --business <id> acts in another one (whoami lists their ids).

4. People

studiox users
studiox users --search lee --role business-support
studiox users invite lee@yourcompany.com --name "Lee Park" --role user
studiox users role lee@yourcompany.com business-support
studiox users rm lee@yourcompany.com

Roles are business-super-admin, business-admin, business-support and user. The same rules apply as in Studio: a business administrator cannot add or promote anyone to business super administrator.

invite makes an account for someone new; someone who already has one joins your business and keeps their role. They sign in with their email; nothing is sent to them. rm takes them out of your business; their account stays.

5. Assistants and what they know

studiox assistants
studiox assistants create IT Help --role "Answers questions about laptops, printers and accounts"
studiox assistants get "IT Help"
studiox assistants update "IT Help" --name "IT Help Desk"
studiox assistants rm "IT Help Desk"

Anywhere a command takes <assistant> you can give its id or its name (or the start of its name, if only one matches).

studiox kb "IT Help"                                   # its documents, and whether each is ready
studiox kb add "IT Help" printer-guide.pdf vpn.docx    # upload files
studiox kb add "IT Help" --text "Open 8am to 6pm" --title "Office hours"
studiox kb add "IT Help" --url https://intranet.yourcompany.com/it/faq
studiox kb rm "IT Help" <document id>

A new document is processed in the background: studiox kb shows it go from processing to ready.

6. Chat

studiox chat "IT Help" "How do I add a printer on a Mac?"

The reply prints, followed by the conversation id. Continue that conversation with --conversation <id>; watch the reply being written with --stream.

With no message, you talk back and forth:

studiox chat "IT Help"

Type /new for a new conversation and /quit (or Ctrl-D) to stop.

studiox conversations "IT Help"      # your conversations with it
studiox messages <conversation id>   # what was said

7. Tokens

studiox tokens create --scopes read,chat --label "intranet search" --expires-days 90
studiox tokens
studiox tokens revoke <id>

The new token prints once: store it then. Scopes:

Scope Lets the token
read Read everything this tool shows
chat Talk to assistants
manage Make, change and delete assistants; add and remove documents
admin Change business settings and people; make tokens

A token never does more than your role allows, and a token can only make tokens with scopes it has itself (and only if it has admin).

Service tokens act as one member of your business — a user you set up for a job, such as robot@yourcompany.com — and only in your business. As an administrator:

studiox users invite robot@yourcompany.com --name "Nightly sync" --role business-admin
studiox tokens create --service-user robot@yourcompany.com --scopes read,manage --label "nightly sync"
studiox tokens --service

A service token keeps working when you leave, every administrator of the business sees it and can revoke it, and it stops working if its user is removed from the business.

8. When something is refused

Each refusal says what happened and what to do next:

error: This token is not allowed "manage". Make a token with that scope. [HTTP 403 scope_missing]
  hint: make a token with scope manage: studiox tokens create --scopes manage
You see Do this
unauthorized The token is wrong, revoked or expired: make a new one and run studiox configure
scope_missing Make a token with the scope named
forbidden Your role, or your business's or assistant's API access setting, does not allow it: ask an administrator
not_found Check the name or id; things in another business read as not found
rate_limited Wait the seconds shown

studiox openapi -o core-api.json saves the full description of the API the tool talks to.

9. Signing in through the browser

This version signs in with configure only. Signing in through the browser will come when Studio can issue Core API tokens from its sign-in page.

Version history

1.0.0 · Oct 19, 2026

First release of studiox: people and roles, assistants and what they know, chat, AI usage and tokens from a terminal or a script.

All platforms

PlatformFileSizeSHA-256
macOS (Intel)studiox-darwin-amd647.0 MBecae7d9d3b153dff924dad92ad3b363220794c09a592716f5b31e2ace4311837
macOS (Apple silicon)studiox-darwin-arm646.4 MB1e61d16d0de9165f5f7adb71357ad0a18b86829eb734455b420c3d021159ade5
Linux x64studiox-linux-amd646.8 MBc0f5bc09b13a9d8466856eeace4a8a28af69cc13d171fb08b7dc86aae0126eaf
Linux arm64studiox-linux-arm646.3 MB1f0df68683930148dd0c09219ce4e4329b06ab2d729861d47ceaaded05c05670
Windows 32-bitstudiox-windows-386.exe6.8 MB76b2a41601508ff769ff7cda3066f1eec804f3dee071d165facecd6d3785e1d8
Windows x64studiox-windows-amd64.exe7.0 MBd3ed2e553bdd7aa10f68e2ccbd5cde31022d4e9bab39c376a090c300b553283b
Windows arm64studiox-windows-arm64.exe6.4 MBdc25f8464a2cc674e5ff05c82eb337cc3ba1b548119a6fd27f5d8f0f10e93cac

SHA256SUMS

Check the file is ours

Compare the file's SHA-256 with the one listed for it before you run it.

# macOS / Linux
shasum -a 256 <file>

# Windows (PowerShell)
Get-FileHash <file> -Algorithm SHA256

Related

  • Missions CLI — Run, manage and build missions from a terminal or a script: ask a mission, approve what's waiting, run watchers, change records and settings, install and upgrade missions.
  • StudioX Core API — Run your business on StudioX from your own code over HTTP: people and roles, assistants and what they know, chat, AI usage, tokens.