Deploy from CI

hypequery cloud is not live yet

You can't sign up for or deploy to cloud today. These pages describe the planned service, and details will change before launch. What runs today is the open-source TypeScript and Python SDKs, in your own backend.

Deploying from CI is the recommended path for production. Cloud generates a GitHub Actions workflow for your project and environment during onboarding and on the Deployments page.

Set up

Create a deployment key on the Keys page, under Deployment.
Add it to your repository as the HYPEQUERY_API_TOKEN secret. If you use GitHub environments, add it to the environment the workflow names.
Commit the generated workflow, for example as .github/workflows/hypequery.yml.

The workflow

The generated workflow looks like this, with your project, environment, and cloud endpoint filled in:

name: Deploy hypequery to production

on:
  push:
    branches:
      - "main"
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: hypequery-deploy-production
  cancel-in-progress: true

jobs:
  deploy:
    name: Deploy production
    runs-on: ubuntu-latest
    environment: "production"
    timeout-minutes: 10
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Preserve Git branch provenance
        run: git checkout -B "$GITHUB_REF_NAME" "$GITHUB_SHA"

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 22

      - name: Install dependencies
        run: npm ci

      - name: Deploy hypequery
        env:
          HYPEQUERY_API_TOKEN: ${{ secrets.HYPEQUERY_API_TOKEN }}
          HYPEQUERY_DEPLOYMENT_ENDPOINT: "<your cloud deployment endpoint>"
        run: >-
          npx --yes --package=@hypequery/cli hypequery deploy 'analytics/cloud.ts'
          --project '<project>'
          --environment 'production'

It deploys on every push to main, and can be run manually.
Only one deploy per environment runs at a time; a newer push cancels an older run.
The branch and commit are recorded with the release, so the Releases view shows exactly which commit is live.
The generated version detects npm, pnpm, or Yarn from your lockfile and pins the CLI version.

Set up

The workflow

On this page

Get early access to hypequery cloud.