Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/whitphx/stlite/llms.txt

Use this file to discover all available pages before exploring further.

@stlite/cli is a command-line tool that converts a local Streamlit project into various Stlite deployment formats — from a single shareable URL to a fully offline web bundle or a standalone Electron desktop application. It is available both as an npm package (Node.js) and as stlite-cli on PyPI.

Installation

You can run the CLI without a permanent install using npx, install it globally via npm, or use the Python distribution via pip or uvx:
npx @stlite/cli <command> <path>
The Python distribution (stlite-cli on PyPI) covers the share and html commands, which produce byte-identical output to the Node.js version. The web and desktop commands are Node.js only — they rely on Pyodide-in-Node tooling that is not available in the Python package.

Requirements

RuntimeMinimum version
Node.js>= 22

Available commands

stlite share

Encode a project as a hash-fragment URL that opens directly on share.stlite.net. No server needed — the entire app is embedded in the URL itself.

stlite html

Export the project as a single self-contained .html file that loads @stlite/browser from jsDelivr and embeds all project files inline.

stlite web

Package the project as a multi-file offline web directory. The output bundles @stlite/browser, the Pyodide runtime, and a pre-vendored site-packages snapshot — no CDN fetch at boot. (Node.js only)

stlite desktop

Package the project into a Stlite Desktop artifact consumed by electron-builder to produce a standalone Electron application. (Node.js only)
For full option references and examples, see the Commands page.

Build docs developers (and LLMs) love