Skip to content
Ghaymah Ghaymah Ghaymah Docs

Platform overview

Ghaymah is a cloud platform, not just a CLI. The gy command line tool is the fastest way to deploy apps, and underneath it sits a full platform with managed services you can drive from your code with a simple REST API.

The pieces

Section titled “The pieces”
Service What it does Create with
Apps Run a containerized app with a public URL, logs, and scaling gy deploy or POST /apps
S3 storage Managed object storage with buckets and scoped access keys POST /s3/buckets
Volumes Persistent disk you can mount into any app POST /volumes
Managed PostgreSQL A production Postgres database, no ops required POST /db/postgres
Secrets Store sensitive key/value values safely POST /secrets
Pull secrets Store private registry credentials for your apps POST /secrets/pull

Everything is grouped into projects, and every resource lives in exactly one project. A project is your isolation boundary — apps, buckets, volumes, databases, and secrets in one project can see each other; resources in different projects cannot.

How it fits together

Section titled “How it fits together”

A typical app uses several services at once:

                        ┌─────────────────────────────┐
                        │           Project           │
                        │                             │
   Public URL ─────────▶│  App (container)            │
                        │    │                        │
                        │    ├── mounts a Volume      │  (files that survive restarts)
                        │    ├── reads from S3        │  (objects, uploads, assets)
                        │    ├── connects to Postgres │  (database)
                        │    └── injects Secrets      │  (API keys, credentials)
                        └─────────────────────────────┘

You can build this with the CLI, the REST API, or both. gy deploy handles the app; the REST API gives you programmatic control over every service for scripts, CI, and your own tooling.

Three ways to drive Ghaymah

Section titled “Three ways to drive Ghaymah”

1. The dashboard

Section titled “1. The dashboard”

Best for seeing everything at a glance. Sign in at deploy.ghaymah.systems and deploy apps, create buckets, volumes, and databases from the browser. Take the Dashboard tour for a guided walkthrough.

2. The gy CLI

Section titled “2. The gy CLI”

Best for humans and day-to-day deploys. It auto-detects your stack, writes the container config, and ships your app:

Terminal window
gy deploy            # ship from the current directory
gy logs my-app       # stream logs
gy config set env DATABASE_URL=postgres://…   # configure without redeploying

See Deploy & manage for the full workflow.

3. The REST API

Section titled “3. The REST API”

Best for automation. Every resource is a JSON API at https://api.cumin.dev:

Terminal window
curl https://api.cumin.dev/health \
  -H "Authorization: Bearer $TOKEN"

The API covers apps, S3 buckets & keys, volumes, managed PostgreSQL, and secrets. Read the REST API overview to get started, then jump to the service you need.

Projects and authentication

Section titled “Projects and authentication”

Before you create anything you need a project and a token:

  • Project — a named container for your resources.
  • Token — a bearer credential scoped to one or more projects.

The CLI creates these for you automatically during gy login and gy deploy. When using the REST API directly, you create a project and mint a token first — the REST API overview walks through it.

Next steps

Section titled “Next steps”