⚡ Quick start

This is the quickest way to get started. Python 3.11 or higher is required.

1. Install PySpur:

   pip install pyspur
   

2. Initialize a new project:

   pyspur init my-project
   cd my-project
   

   This will create a new directory with a .env file.

3. Start the server:

   pyspur serve --sqlite
   

   By default, this will start PySpur app at http://localhost:6080 using a sqlite database. We recommend you configure a postgres instance URL in the .env file to get a more stable experience.

4. [Optional] Configure Your Environment and Add API Keys:

   • App UI: Navigate to API Keys tab to add provider keys (OpenAI, Anthropic, etc.)
   • Manual: Edit .env file (recommended: configure postgres) and restart with pyspur serve