pyspur

(โ˜… 5,774)

A visual playground for agentic workflows: Iterate over your agents 10x faster

  • .dockerignore
  • .env.example
  • .gitignore
  • .pre-commit-config.yaml
  • docker-compose.dev.yml
  • docker-compose.staging.yml
  • docker-compose.yml
  • Dockerfile.backend
  • Dockerfile.frontend
  • generate_migrations.sh
  • LICENSE
  • README.md
  • README_CN.md
  • README_DE.md
  • README_ES.md
  • README_FR.md
  • README_JA.md
  • README_KR.md
  • start_pyspur_docker.sh

# Installation Guide

1. Get the code
git clone https://github.com/PySpur-Dev/pyspur

Downloads the entire project code from GitHub to your computer.

cd pyspur

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Python 3 Python is required to use pip.
pip install pyspur

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose -f docker-compose.dev.yml up --build -d

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

4. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd frontend

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

5. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install pyspur

Installs the package published on PyPI directly โ€” no need to clone the source.

โœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

// repository documentation