Hello there 👋

Thanks for stopping by! We use cookies to help us understand how you interact with our website.

By clicking “Accept all”, you consent to our use of cookies. For more information, please see our privacy policy.

  1. Contents
  2. $ streamlit init
  3. Syntax
  4. Arguments
  5. Examples
  6. Example 1: Create project files the current working directory
  7. Example 2: Create project files in another directory

$ streamlit init

This command creates the files for a new Streamlit app.

Syntax

streamlit init <directory>

Arguments

<directory> (Optional): The directory location of the new project. If no directory is provided, the current working directory will be used.

Examples

Example 1: Create project files the current working directory

  1. In your current working directory (CWD), execute the following:

    streamlit init

    Streamlit creates the following files:

    CWD/ ├── requirements.txt └── streamlit_app.py

  2. In your terminal, Streamlit prompts, ❓ Run the app now? [Y/n]. Enter Y for yes.

    This is equivalent to executing streamlit run streamlit_app.py from your current working directory.

  3. Begin editing your streamlit_app.py file and save your changes.

Example 2: Create project files in another directory

  1. In your current working directory (CWD), execute the following:

    streamlit init project

    Streamlit creates the following files:

    CWD/ └── project/ ├── requirements.txt └── streamlit_app.py

  2. In your terminal, Streamlit prompts, ❓ Run the app now? [Y/n]. Enter Y for yes.

    This is equivalent to executing streamlit run project/streamlit_app.py from your current working directory.

  3. Begin editing your streamlit_app.py file and save your changes.

Previous: streamlit helpNext: streamlit run
forum

Still have questions?

Our forums are full of helpful information and Streamlit experts.