Installing Spout Workspace

Spout is still in development phase for now, but you are welcome to become a beta-tester by following these simple steps.

Prerequisites

Before installing the Spout, ensure you have:

• Git installed on your system
• Internet connection

Step 1: Clone the Project Repository

Create a workspace directory

mkdir spout_workspace
cd spout_workspace

Clone the Spout repository

git clone https://github.com/skjp/spout.git .

Step 2: Install Python and CLI Tool

Python Installation

1. Download Python 3.10+ from python.org
2. During installation:
   • ✅ Check "Add Python to PATH"
   • ✅ Check "Install pip"
3. Verify installation:

python --version
pip --version

Install Spout CLI

Navigate to the spout directory and install in development mode

cd spout_workspace
pip install -e .

Verify CLI Installation

spout --help

If you see the help documentation, the CLI is installed correctly

Check out other Spout terminal commands at Essentials/CLI

Step 3: Install GUI Scripts (Windows Only)

1. Download the latest version of AutoHotkey from autohotkey.com
2. Run the installer with default settings
3. After AutoHotkey is installed, run the QuickStart script:
   • Navigate to the spout_workspace directory
   • Find QuickStart.ahk
   • Right Click and select "Open", or run ./QuickStart.ahk in the terminal. If this is the first AHK script you've run on your system, you may need to run the file as administrator.
   • Select your preferred keyboard console from the options and click "Run"

Next Steps

• Get API keys from your account(s*) on OpenAI, Anthropic, Google Gemini, DeepSeek and/or Replicate and save them in the Settings GUI (opened by pressing Capslock + ` ), or add the raw API keys in the spout/config/settings.ini file. *Spout only needs one active API key for full functionality.
• Add a link to your preferred console script to the Windows Startup folder so it starts automatically on login. You can also do this by clicking the "Add to Startup" button in the Settings GUI
• Check out the Default Consoles Hotkeys Layouts and have fun!
• Keep reading the documentation for more information.
• To get the latest project updates, pull from the main branch:

# Navigate to your spout directory
cd spout_workspace
# Pull the latest changes from the main branch
git pull origin main

• or fork the repository and create you own implementation

# Navigate to your spout directory
cd spout_workspace
# Create a new branch
git checkout -b my-spout-fork