Skip to main content
Version: 4.0.0-preview

Studio

Launch ExpressoTS Studio, the local developer experience platform, from your project root.

expressots studio [options]

What it does

  1. If @expressots/studio is not a devDependency, the CLI installs it as one using your project's package manager (detected from the lockfile).
  2. Spawns node_modules/.bin/expressots-studio start with the forwarded options.
  3. Studio's UI opens in your browser (unless --no-browser is set).

Options

FlagAliasDefaultDescription
--port-p3333UI port.
--agent-port-a3334Agent WebSocket port. Must match EXPRESSOTS_STUDIO_PORT if set.
--src./srcSource directory to scan.
--no-browserfalseDon't open the browser automatically.

Examples

# Default ports, opens browser
expressots studio

# Custom ports, no browser (e.g. inside a remote dev container)
expressots studio --port 4000 --agent-port 4001 --no-browser

# Different source folder
expressots studio --src ./apps/api/src

Prerequisites

  • Studio activates only in development. Make sure NODE_ENV is development or unset.
  • @expressots/studio-agent must be installed as a devDependency of your app. If it's missing, the agent never starts and you'll see an empty UI. See Studio Installation for the full activation rules.

See also