GitHub Integration

Deploy your agents directly from GitHub repositories. Push your code, Reminix handles the rest.

How It Works

┌─────────────┐     ┌─────────────┐     ┌─────────────┐
│   GitHub    │ ──▶ │   Reminix   │ ──▶ │   Agent     │
│  (Push)     │     │  (Deploy)   │     │  (Running)  │
└─────────────┘     └─────────────┘     └─────────────┘

1. Connect — Link your GitHub repository to Reminix
2. Push — Commit and push your agent code
3. Deploy — Reminix automatically builds and deploys
4. Call — Your agent is live and callable via API

Connecting Your Repository

1. Go to Reminix Dashboard
2. Navigate to your project settings
3. Click "Connect GitHub"
4. Select your repository
5. Choose the branch to deploy from (default: main)

Repository Structure

Reminix automatically detects your agent entry point:

Python

Checked in order:

1. agent.py
2. main.py
3. app.py
4. src/agent.py
5. src/main.py

TypeScript/JavaScript

Checked in order:

1. package.json → start script
2. agent.ts / agent.js
3. index.ts / index.js
4. src/agent.ts / src/index.ts

Port Requirements

Your agent must listen on port 8080. The runtime handles this by default:

# Python
serve(agent, port=8080)

// TypeScript
serve(agent, { port: 8080 });

Or read from environment:

import os
serve(agent, port=int(os.environ.get("PORT", 8080)))

Environment Variables

Set environment variables in the Reminix Dashboard:

1. Go to Project Settings → Environment
2. Add your variables (e.g., OPENAI_API_KEY)
3. Variables are available at runtime via os.environ (Python) or process.env (TypeScript)

Never commit secrets to your repository. Use environment variables for API keys and sensitive configuration.

Auto-Deploy

When enabled, Reminix automatically deploys when you push to your configured branch:

git add .
git commit -m "Update agent"
git push origin main
# → Deployment starts automatically

Deployment Status

Monitor deployments in the Dashboard:

Build Process

Reminix automatically:

1. Detects language — Python or TypeScript
2. Installs dependencies — pip install or npm install
3. Builds — Runs build scripts if present
4. Starts — Runs your agent on port 8080

Python

pip install -r requirements.txt  # or poetry install
python agent.py

TypeScript

npm install
npm run build  # if build script exists
npx tsx agent.ts  # or node dist/index.js

Troubleshooting

Next Steps

• Python Quickstart — Build a Python agent
• TypeScript Quickstart — Build a TypeScript agent
• Authentication — Get your API key