CLI - streamlit

streamlit


The streamlit group generates and runs Streamlit applications. Use it to scaffold a new Streamlit app in your brick and to run an existing app locally in development mode, so you can iterate on the UI against the running lab.



streamlit run


Runs a Streamlit app in development mode from its JSON config file. The app is started with auto-reload so you can iterate on the code and see changes live. Optionally enable the debugger to step through the app's code.


gws streamlit run  [OPTIONS]


# Run a Streamlit app in dev mode
gws streamlit run ./my_app/app_config.json

# Run with the debugger enabled
gws streamlit run ./my_app/app_config.json --enable-debugger

streamlit generate


Generates a new Streamlit app scaffold. Pass the app name in snake_case. Optionally configure the app to run inside a virtual environment (pipenv, Conda, or Mamba); by default no virtual environment is used.


gws streamlit generate  [OPTIONS]


# Generate a new app with no virtual environment
gws streamlit generate my_app

# Generate an app that runs in a Conda environment
gws streamlit generate my_app --env CONDA
Shine Logo
Technical bricks to reuse or customize

Have you developed a brick?

Share it to accelerate projects for the entire community.