Everything in the console, from your terminal or your agent's.
One standalone CLI for people and agents. Install, sign in through your browser, choose an authorized organization, and inspect your identity. Then create workspaces, deploy, invite members, connect domains, run jobs and query data, with structured JSON on supported commands.
Get started
curl -fsSL https://segmentstream.com/install.sh | shexport PATH="$HOME/.segmentstream/bin:$PATH"segmentstream --versionsegmentstream loginsegmentstream org list# Replace org_YOUR_ID with an organization ID from the list.segmentstream org use org_YOUR_IDsegmentstream whoamiAt a glance
- JSON login events and structured output on supported commands
- Account sign-in with your authorized workspace access
- Self-updating; keeps your agent docs current
- macOS on Apple Silicon; glibc Linux on ARM64 and x64
What it does
Sign in
segmentstream login prints a sign-in link and opens it in your browser. Approve it, and keep the terminal open until it reports success. On a machine without a browser, open the link on any device and enter the code it shows. whoami shows who you are signed in as.
Choose an organization
After sign-in, list the organizations you belong to and choose one; every command also takes --organization. With none yet, ask an administrator for access or create one with org create NAME --country ISO.
Sign in from an agent
A coding agent runs login --output json in a process that stays alive, shows the person the sign-in link it prints, and waits for status succeeded before it continues. For unattended work, such as CI, use an API key in SEGMENTSTREAM_API_KEY instead.
segmentstream login --output json# After the login event reports status succeeded:segmentstream org list --output json# Replace org_YOUR_ID with an ID from that result.segmentstream org use org_YOUR_IDsegmentstream whoami --output jsonProxies and restricted machines
Network commands honor HTTP_PROXY, HTTPS_PROXY, ALL_PROXY and NO_PROXY, SOCKS5 included. To install where your home directory is read-only, point TMPDIR, SEGMENTSTREAM_VERIFY_HOME and SEGMENTSTREAM_INSTALL_DIR at directories you own; signature and checksum checks always run.
export ALL_PROXY="socks5://127.0.0.1:1080"segmentstream whoami --output json# Install with a read-only homeroot="/writable/segmentstream"mkdir -p "$root/tmp" "$root/verify" "$root/bin"curl -fsSL https://segmentstream.com/install.sh | \ TMPDIR="$root/tmp" \ SEGMENTSTREAM_VERIFY_HOME="$root/verify" \ SEGMENTSTREAM_INSTALL_DIR="$root/bin" shWorkspaces
A new workspace comes with a private git repository that already holds the starter project. Clone it, commit your changes and deploy; an existing workspace works the same way without the create step.
# Start a new workspacesegmentstream workspace create acme --region eu --subdomain acmesegmentstream workspace WORKSPACE-ID clone acme && cd acme# your agent writes the five foldersgit add -A && git commit -m "First version"segmentstream deploy# Work on an existing workspacesegmentstream workspace WORKSPACE-ID clone acme && cd acme# your agent makes the changegit add -A && git commit -m "Add purchase orders"segmentstream deployDeploy and inspect
Deploy the five folders together and inspect what is live.
segmentstream deploysegmentstream lineage show --output jsonsegmentstream lineage asset gold/revenue_summaryMembers, keys and MCP
Invite the people who use the app, give them roles, and create API keys for the systems that call it.
segmentstream ontology member invite ada@example.com --role salessegmentstream ontology member listsegmentstream ontology api-key create website --role intakesegmentstream ontology mcpJobs, backfills and schedules
Run and backfill jobs by date range, read run history and pause schedules.
segmentstream job run revenue_pipeline --start-date 2026-01-02 --end-date 2026-01-03segmentstream job runs revenue_pipeline --output jsonsegmentstream schedule pause revenue_morningData
Preview tables, run read-only SQL and ask the ontology for totals.
segmentstream warehouse preview gold revenue_summarysegmentstream warehouse query --sql 'SELECT COUNT(*) AS n FROM gold.orders'segmentstream ontology query-metrics order --query query.jsonConnections, secrets and agent docs
Inspect connections and manage secrets without pasting them into code. upgrade keeps the SDKs, AGENTS.md, the docs and the skills your agent reads up to date.
segmentstream connection list --output jsonsegmentstream secret create api-token --value-file /secure/path/tokensegmentstream upgradeYour own domain
Serve the app at a domain you own: connect it, publish the DNS records the CLI prints, name it in app/domains.json and deploy. HTTPS, sign-in and redirects follow. Or order a new domain for the workspace.
segmentstream domain connect example.com # the DNS records to publishsegmentstream domain check example.com# app/domains.json# {"primary": "example.com", "redirects": ["www.example.com"]}git add app/domains.json && git commit -m "Serve the app at example.com"segmentstream deploysegmentstream domain search example.net --years 1segmentstream domain buy example.net --workspace WORKSPACE-ID --years 1What the platform supports, offline
init writes the workspace starter without signing in or going online. Its AGENTS.md, docs/ and .agents/skills/ describe every part of the platform, so an agent can check what is possible before it builds.
segmentstream init ./segmentstream-startercat segmentstream-starter/AGENTS.mdls segmentstream-starter/docs segmentstream-starter/.agents/skillsThe repository the CLI clones and deploys.
segmentstream workspace clone gives you the repository; segmentstream deploy ships the exact commit you review.

The rest of the surface
Ontology SDK
@segmentstream/ontology
Entities, actions and roles; REST, OpenAPI and MCP from one model
App SDK
@segmentstream/app
Email-code sign-in, roles, records and warehouse data for Next.js
Pipeline SDK
segmentstream-pipeline (Python)
Connections, ingestion, models, checks and schedules in Python
Agent SDK
@segmentstream/agent
The company agent: ontology tools as the member, in your team’s channels
MCP and API
/mcp and /api/ontology on every app
REST, OpenAPI and MCP on every app, per caller
Build your company’s own software. Let agents run it.
$ segmentstream workspace create acme --region eu --subdomain acme
▸ Created workspace acme · database, warehouse and a private git repository
$ segmentstream workspace WORKSPACE-ID clone acme && cd acme
▸ your coding agent builds what your team asked for and runs the checks
$ git add -A && git commit -m "First version"
$ segmentstream deploy
▸ app, company agent, API and MCP tools live for your invited members
Our engineers build the first version on your data in two weeks, at a fixed price.
Or build it yourself with your coding agent:
curl -fsSL https://segmentstream.com/install.sh | sh