Documentation

Learn how to deploy and manage your applications with Saturday - the mobile-first deployment platform.

Quick Start

Get up and running with Saturday in under 5 minutes. Deploy your first app using just your phone.

Connect GitHub

Link your GitHub repository to Saturday

Setup Bot

Configure Telegram or WhatsApp bot

Deploy

Send a message to deploy your app

Installation

1. Create Account

Create Account

curl -X POST https://api.saturday.dev/auth/signup \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your@email.com",
    "password": "your-password"
  }'

2. Install CLI (Optional)

Install the Saturday CLI for advanced features and local development.

Install CLI

npm install -g @saturday/cli

# Or with yarn
yarn global add @saturday/cli

# Or with pnpm
pnpm add -g @saturday/cli

3. Login

Authenticate with your Saturday account.

saturday login

Telegram Bot

Setup

Connect your Telegram account to start deploying via messages.

Bot Username

@SaturdayDeployBot

Search for @SaturdayDeployBot on Telegram
Send /start to begin setup
Follow the authentication flow
Connect your GitHub repositories

Commands

/deploy

Deploy Application

Deploy your app to production

/status

Check Status

View deployment status and logs

/rollback

Rollback

Rollback to previous version

/logs

View Logs

Get recent deployment logs

Commands Reference

Basic Commands

Deploy Command

/deploy [project-name] [branch]

# Examples:
/deploy my-app main
/deploy my-app feature/new-ui
/deploy my-app

Status Command

/status [project-name]

# Examples:
/status my-app
/status

Advanced Commands

Environment Variables

/env [project-name] [key=value]

# Examples:
/env my-app NODE_ENV=production
/env my-app DATABASE_URL=postgres://...
/env my-app --list

Domain Management

/domain [project-name] [domain]

# Examples:
/domain my-app myapp.com
/domain my-app --list
/domain my-app --remove myapp.com

REST API

Authentication

All API requests require authentication using your API key.

Authentication Header

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.saturday.dev/v1/projects

Endpoints

GET/v1/projects

List all projects

POST/v1/projects/{id}/deploy

Deploy a project

GET/v1/deployments/{id}

Get deployment details

Frequently Asked Questions

How long does a deployment take?

Most deployments complete in under 2 minutes. Complex builds may take up to 5 minutes.

Can I deploy private repositories?

Yes, Saturday supports private GitHub repositories. You'll need to grant access during setup.

What frameworks are supported?

We support all major frameworks: React, Vue, Angular, Next.js, Nuxt.js, Svelte, and static sites.

How do I set up custom domains?

Use the /domain command in Telegram or configure through the web dashboard. SSL certificates are automatically provisioned.

Community & Support

Discord

Join our community for real-time help

GitHub

Report issues and contribute

Support

Get help from our team