When you install Streamlit, the Streamlit command-line CLI tool gets installed as well. The main purpose of this tool is to help you diagnose and fix issues.
You can find docs for our CLI tool as usual:
$ streamlit --help
Below are a few of the most useful commands accepted by Streamlit CLI:
Run Streamlit apps¶
$ streamlit run your_script.py [-- script args]
Runs your app. At any time you can kill the server with Ctrl+c.
When passing your script some custom arguments, they must be passed after two dashes. Otherwise the arguments get interpreted as arguments to Streamlit itself.
You can also pass in config options to
streamlit run. These allow you to do
things like change the port the app is served from, disable run-on-save, and
more. To see all options, run:
$ streamlit run --help
If you want to permanently set certain config options, just add them to $CWD/.streamlit/config.toml or to a global ~/.streamlit/config.toml (in Windows this would be %userprofile%/.streamlit/config.toml). More info below.
Run a cool demo¶
$ streamlit hello
Opens Streamlit’s Hello World app in a web browser. This is useful for testing Streamlit.
View all config options¶
$ streamlit config show
Shows all config options available for Streamlit, including their current values. You can set these options in four different ways:
In a global config file at
~/.streamlit/config.toml. For instance:
[server] port = 80
In a per-project config file at
$CWDis the folder you’re running Streamlit from.
STREAMLIT_*environment variables, such as:
$ export STREAMLIT_SERVER_PORT=80
As flags in the command line when running
streamlit run. For example:
$ streamlit run your_script.py --server.port 80
$ streamlit docs
Opens Streamlit’s documentation (i.e. this website) in a web browser.
Print Streamlit’s version¶
$ streamlit --version
Shows the version of Streamlit in your current Python environment.