CLI commands

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.

Command	Purpose
`hypequery login`	Authorize this machine with hypequery cloud and save a default project and environment
`hypequery logout`	Revoke and remove the local cloud credential
`hypequery deploy <source>`	Build, release, and submit a TypeScript publication in one step
`hypequery deployment:build <cloud>`	Build a verified deployment bundle without releasing it
`hypequery deployment:release <bundle>`	Bind a bundle to a project and environment as a release
`hypequery deployment:submit <bundle> --release <path>`	Submit a prebuilt bundle and release
`hypequery deployment:status`	Show the live release and hosted REST and MCP URLs
`hypequery deployment:validate <artifact>`	Verify a bundle or contract and report its identity
`hypequery pull`	Download the source snapshot from the live deployment
`hypequery diff [source]`	Compare local source with the live deployment
`hypequery mcp --self-test --url <url>`	Check a hosted MCP endpoint

Most commands accept --project and --environment to override the target saved by hypequery login.

`hypequery deploy <cloud>`

Builds the publication module, prepares a release for the logged-in target, and submits it. Once cloud accepts the release, the CLI prints where it's 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/mcp

Cloud provides these URLs, so the CLI follows cloud's current routing. A live release is required before dataset calls work. A cloud release that doesn't provide endpoint details leaves deploy output unchanged.

Option	Description
`--mcp-config`	Also print MCP client configuration for the hosted endpoint. It reads the key from `${HYPEQUERY_API_KEY}` and never contains a credential
`--project`, `--environment`	Override the target from `hypequery login`
`--replace-restored`	Replace a live release that was restored from history
`--no-source`	Leave project source files out of the bundle

`hypequery deployment:status`

Shows the current release and cloud-provided REST and MCP URLs without building or deploying again. It uses the target and deployment credential saved by hypequery login. With an explicit deployment credential, pass both --project and --environment.

npx hypequery deployment:status
npx hypequery deployment:status --mcp-config

The command says when no release is live. Its optional MCP configuration uses ${HYPEQUERY_API_KEY} as a placeholder and never includes the stored deployment credential.

Option	Description
`--project`, `--environment`	Override the target from `hypequery login`; pass both together
`--endpoint`	Use an explicit cloud submission endpoint with `HYPEQUERY_API_TOKEN`
`--mcp-config`	Also print MCP client configuration for the hosted endpoint

`hypequery deploy <cloud>`

`hypequery deployment:status`

On this page

Get early access to hypequery cloud.