Utiliser la CLI Streamlit

La CLI Streamlit est l'outil principal pour exécuter des applications Streamlit et gérer la configuration. Cette skill couvre toutes les commandes essentielles et les options de configuration.

Exécuter des applications Streamlit

Syntaxe de base

streamlit run [<entrypoint>] [-- config options] [script args]

Options d'entrypoint

Exemples

# Exécuter l'application par défaut dans le répertoire courant
streamlit run

# Exécuter un fichier spécifique
streamlit run app.py

# Exécuter depuis une URL
streamlit run https://raw.githubusercontent.com/streamlit/demo-uber-nyc-pickups/master/streamlit_app.py

# Alternative : exécuter en tant que module Python (utile pour la configuration IDE)
python -m streamlit run app.py

Exécuter avec uv (recommandé)

Utilisez uv run pour exécuter Streamlit dans un environnement virtuel avec gestion automatique des dépendances :

# Exécuter avec uv (utilise/crée automatiquement un environnement virtuel)
uv run streamlit run app.py

# Avec des options de configuration
uv run streamlit run app.py --server.headless=true

# Avec des arguments de script
uv run streamlit run app.py -- arg1 arg2

L'utilisation de uv run est l'approche recommandée car elle :

• Gère automatiquement les environnements virtuels
• Résout et installe les dépendances depuis pyproject.toml
• Assure des environnements reproductibles sur les différentes machines
• Évite l'activation/désactivation manuelle des environnements virtuels

Définir la configuration avec streamlit run

Les options de configuration suivent le modèle --<section>.<option>=<value> et doivent venir après le nom du script.

Recommandation : Pour une configuration persistante, utilisez .streamlit/config.toml dans votre répertoire de projet au lieu de drapeaux en ligne de commande. Cela garde votre commande run simple et rend la configuration plus facile à gérer et partager avec votre équipe.

Exemples

streamlit run app.py --server.port=8080
streamlit run app.py --server.headless=true
streamlit run app.py --server.runOnSave=true
streamlit run app.py --server.address=0.0.0.0
streamlit run app.py --client.showErrorDetails=false
streamlit run app.py --theme.primaryColor=blue

Combiner plusieurs options

streamlit run app.py \
    --server.port=8080 \
    --server.headless=true \
    --theme.primaryColor=blue \
    --client.showErrorDetails=false

Passer des arguments à votre script

Les arguments du script viennent après les options de configuration. Utilisez sys.argv pour y accéder :

streamlit run app.py -- arg1 arg2 "arg with spaces"

Dans votre script :

import sys

# sys.argv[0] = chemin du script
# sys.argv[1:] = vos arguments
args = sys.argv[1:]

Autres commandes CLI

Afficher la configuration

# Afficher tous les paramètres de configuration actuels
streamlit config show

Gestion du cache

# Effacer toutes les données en cache du disque
streamlit cache clear

Diagnostics et aide

# Afficher la version installée
streamlit version

# Lister toutes les commandes disponibles
streamlit help

# Ouvrir la documentation dans le navigateur
streamlit docs

Scaffolding de projet

# Créer des fichiers de démarrage pour un nouveau projet
streamlit init

Application de démonstration

# Lancer l'application de démonstration Streamlit
streamlit hello

Ordre de précédence de la configuration

La configuration peut être définie à plusieurs endroits. Ordre de précédence (du plus élevé au plus bas) :

1. Drapeaux en ligne de commande (--server.port=8080)
2. Variables d'environnement (STREAMLIT_SERVER_PORT=8080)
3. Configuration locale (.streamlit/config.toml dans le répertoire du projet)
4. Configuration globale (~/.streamlit/config.toml)

Références

• Run your app - Concepts et méthodes pour exécuter des applications Streamlit
• config.toml - Référence complète des options de configuration
• CLI reference - Documentation complète des commandes CLI