Cloud
Deploy from TypeScript
Publish TypeScript datasets to hypequery cloud with publishToCloud and hypequery deploy.
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.
1. Declare what cloud publishes
Create a deployment entrypoint that exports the result of publishToCloud as cloud:
// analytics/cloud.ts
import { publishToCloud } from '@hypequery/datasets';
import { orders } from './orders';
export const cloud = publishToCloud({
datasets: { orders },
access: { roles: ['analyst'], scopes: [] },
});datasetslists the datasets cloud exposes. Datasets they relate to are included as supporting datasets.accessis required: the roles and scopes callers need for every published dataset.datasetAccessoptionally sets a different policy for individual datasets, keyed by published name.
publishToCloud makes no network request. It only builds the contract that the CLI uploads.
2. Log in
npx hypequery loginThis authorizes the machine with hypequery cloud and saves your default project and environment.
3. Deploy
npx hypequery deploy analytics/cloud.tsThe CLI builds a bundle, prepares a release for your target, and submits it. Once cloud accepts the release, it prints where the datasets are served:
Hosted endpoints
REST https://<environment-slug>.hypequery.app
orders POST https://<environment-slug>.hypequery.app/api/analytics/datasets/orders/query
MCP https://<environment-slug>.hypequery.app/mcpAdd --mcp-config to also print a ready-to-use MCP client configuration.
Useful options
| Option | Description |
|---|---|
--project, --environment | Deploy to a different target than the one saved by hypequery login |
--no-source | Leave project source files out of the bundle |
--mcp-config | Print MCP client configuration for the hosted endpoint |
--replace-restored | Replace a live release that was restored from history |