Skip to main content

stml — the partner CLI

Pull an app you built on the platform down to a local folder, edit it with your own editor and git, push it back to test, and publish a finished version to the App Store — without cloning the stml4 monorepo.

Spec: docs/user-stories/feature/024-app-authoring-platform.md.

Requirements

  • Python 3.11 or newer on your PATH. That's the only hard requirement.
    • macOS: brew install python@3.12 (or python.org). Not the system /usr/bin/python3 — it's often 3.9, which is too old.
    • Linux: your distro's Python 3.11+, or pipx/pyenv/uv.
    • Windows 10/11: the python.org installer (gives you the py launcher).

Install

Method Command
pipx (recommended) pipx install stml-cli
pip (in a venv) pip install stml-cli
single file (no installer) curl -fsSL <backend>/cli/stml -o stml && chmod +x stml

Runs on macOS, Linux, and Windows — it's pure-Python and touches nothing platform-specific beyond the filesystem and HTTPS.

Quickstart

# Talks to https://api.stml.io by default — nothing to set.
# Override only for local dev:  export STML4_BACKEND=http://localhost:8010

# 1. Sign in — opens your browser; approve, and a session is cached locally.
stml login
stml whoami

# 2. See your apps and their URLs (the handle you pull/push by).
stml list

# 3. Pull an app's source into a folder — identify it by its URL (copy from
#    `stml list` or the browser; a trailing /flows/… or /sessions/… is fine).
stml pull https://app.stml.io/orgs/acme/ws/main/apps/my-app-a1b2 ./my-app

# 3. Edit with your own tools, commit to git, whatever.

# 4. Push it back — checks, writes the overlay, and deploys in one step.
stml push ./my-app          # app remembered from pull
#   or: stml push https://app.stml.io/orgs/acme/ws/main/apps/my-app-a1b2 ./my-app

# 5. When ready, publish a version to the App Store.
#    (bump project.version in pyproject.toml first; set [tool.stml].issuer-org)
stml publish ./my-app

Authentication

stml login runs the platform's browser OAuth flow: you authenticate in the browser, approve, and a refresh token is cached under your OS config dir (~/Library/Application Support/stml, $XDG_CONFIG_HOME/stml, or %APPDATA%\stml). Access tokens are minted per-command and never written to disk.

STML4_TOKEN, if set, overrides the cache verbatim — how CI and the monorepo (STML4_TOKEN=$(npm run --silent token)) authenticate.

Commands

Command What
stml login / logout / whoami session auth
stml list [--workspace <ws>] list your apps with their app URLs
stml pull <app-url> [<dir>] pull overlay source to a folder (bare slug also works)
stml push [<app-url>] <dir> push a folder to the overlay and deploy (--no-deploy, --prune)
stml publish <dir> [--org <slug>] publish a library version from a folder
stml init <dir> [--name <name>] scaffold a new library directory

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stml_cli-0.1.5.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stml_cli-0.1.5-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file stml_cli-0.1.5.tar.gz.

File metadata

  • Download URL: stml_cli-0.1.5.tar.gz
  • Upload date:
  • Size: 22.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for stml_cli-0.1.5.tar.gz
Algorithm Hash digest
SHA256 b1fa80a624d7bdf611ac4cb2176fd63cbf0c8d69fcdd28faf509eff1b2edb09b
MD5 ca4fdf3fd4b4ed67601fb16f1f3fe016
BLAKE2b-256 225fd4f58af469b99761dc1e44f281d08f41dfe1beaf67cfa2972ab4736401a0

See more details on using hashes here.

File details

Details for the file stml_cli-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: stml_cli-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.8

File hashes

Hashes for stml_cli-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3e10629b186afd629fec876f0651f65b7a9bbdb704c0f63b2361b2f8625224c3
MD5 422a589c9db613b8f5d31c907b8c9c0d
BLAKE2b-256 14774318273d5cb1362951a678bcf56a4295099dc61e2b3ffdbf5ee56a7fb7e9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page