Spaces:
Sleeping
Sleeping
File size: 1,433 Bytes
746d2f1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
---
title: Command-line options
slug: /develop/api-reference/cli
---
# Command-line interface
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.
To see all of the supported commands:
```bash
streamlit --help
```
### Run Streamlit apps
```bash
streamlit run your_script.py [-- script args]
```
Runs your app. At any time you can stop the server with **Ctrl+c**.
<Note>
When passing your script some custom arguments, **they must be passed after
two dashes**. Otherwise the arguments get interpreted as arguments to Streamlit
itself.
</Note>
To see the Streamlit 'Hello, World!' example app, run `streamlit hello`.
### View Streamlit version
To see what version of Streamlit is installed, just type:
```bash
streamlit version
```
### View documentation
```bash
streamlit docs
```
Opens the Streamlit documentation (i.e. this website) in a web browser.
### Clear cache
```bash
streamlit cache clear
```
Clears persisted files from the on-disk [Streamlit cache](/develop/api-reference/caching-and-state), if
present.
### View all configuration options
As described in [Configuration](/develop/concepts/configuration), Streamlit has several
configuration options. To view them all, including their current values, just type:
```bash
streamlit config show
```
|