Command-line options

When you install Streamlit, a command-line (CLI) tool gets installed as well. The purpose of this tool is to run Streamlit apps, change Streamlit configuration options, and help you diagnose and fix issues.

• What is the command-line interface (CLI)?
• How to run Streamlit apps from the CLI?
• View Streamlit version from the CLI?
• View documentation from the CLI
• Clear cache from the CLI

Streamlit configuration

Streamlit provides four different ways to set configuration options. Learn how to use each of them to change the behavior of Streamlit.

• How to set configuration options?
• Opt out of telemetry collection
• View all configuration options

Theming

This section provides examples of how Streamlit page elements are affected by the various theme config options.

• primaryColor
• backgroundcolor
• secondarybackgroundcolor
• textcolor
• font
• base

Caching

The Streamlit cache allows your app to stay performant even when loading data from the web, manipulating large datasets, or performing expensive computations. To cache a function in Streamlit, you need to decorate it with one of two decorators: st.cache_data and st.cache_resource.

• Minimal example
• Basic usage
  • st.cache_data
  • st.cache_resource
  • Deciding which caching decorator to use
• Advanced usage
  • Excluding input parameters
  • Controlling cache size and duration
  • Customizing the spinner
  • Using Streamlit commands in cached functions
  • Mutation and concurrency issues
• Migrating from st.cache

Add statefulness to apps

Session State is a way to share variables between reruns, for each user session. In addition to the ability to store and persist state, Streamlit also exposes the ability to manipulate state using Callbacks.

• What is Session State?
• How to initialize Session State items?
• How to read and update Session State items?
• How to use callbacks in Session State?
• How to use args and kwargs in callbacks?
• How to use callbacks in forms?
• How is Session State related to Widget State?
• Caveats and limitations

Pre-release features

At Streamlit, we like to move quick while keeping things stable. In our latest effort to move even faster without sacrificing stability, we're offering our bold and fearless users two ways to try out Streamlit's bleeding-edge features.

• Experimental features
• Nightly releases

Secrets management

This section provides examples of how to use secrets management to store and retrieve sensitive information in your Streamlit app.

• Develop locally and set up secrets
• Use secrets in your app
• Error handling
• Use secrets on Streamlit Community Cloud

Working with timezones

Working with timezones can be tricky. This section provides a high-level description of how to handle timezones in Streamlit to avoid unexpected behavior.

• Overview
• How Streamlit handles timezones
• datetime instance without a timezone (naive)
• datetime instance with a timezone

Advanced notes on widget behavior

Widgets are magical and often work how you want. But they can have surprising behavior in some situations. This section provides is a high-level, abstract description of widget behavior, including some common edge-cases.