Stellate CLI

3.2.13 verified Sat Apr 25 auth: no javascript

The official command-line tool for managing Stellate GraphQL edge caching services. Version 3.2.13, requires Node.js ^24.13.0 and pnpm ^9.15.0. Provides commands for authentication (login), service setup (init), config synchronization (pull, push), schema validation (check, subset), local development (serve), and listing apps (ls). Key differentiator: full lifecycle management of Stellate services from the terminal, with automatic API token handling stored in ~/.stellate. TypeScript types included.

Common errors

error Error: Cannot find module 'stellate' ↓

cause Package not installed or import path incorrect.

fix

Run pnpm add stellate in your project directory, then ensure your import uses import { Stellate } from 'stellate'.

error TypeError: stellate_1.Stellate is not a constructor ↓

cause Default import used instead of named import.

fix

Replace import Stellate from 'stellate' with import { Stellate } from 'stellate'.

error Error: The engine 'node' is incompatible with this module. Expected version '^24.13.0' ↓

cause Node.js version is lower than 24.13.0.

fix

Upgrade Node.js to version 24.13.0 or higher. Use nvm or download from nodejs.org.

error Error: Could not authenticate. No API token found and interactive login not available. ↓

cause Running in a non-interactive environment without a preconfigured token.

fix

Set the STELLATE_API_KEY environment variable with a valid API token, or run stellate login interactively.

Warnings

breaking Node.js version requirement: ^24.13.0 ↓

fix Update Node.js to version 24.13.0 or higher (matching the engine requirement). Older versions will not work.

gotcha pnpm is required as the package manager; yarn and npm may cause issues with workspace linking. ↓

fix Install pnpm globally (`npm i -g pnpm`) and use `pnpm install` to set up dependencies.

deprecated The 'check' command is marked as BETA and may have breaking changes or be removed in future versions. ↓

fix Use with caution in CI; monitor Stellate changelog for updates.

gotcha Authentication tokens are stored in ~/.stellate directory. Changing the STELLATE_ENDPOINT environment variable will use a different token file, which may cause confusion if you forget to re-authenticate. ↓

fix Always verify which token file is being used when switching environments. Re-run `login` if needed.

Install

npm install stellate

yarn add stellate

pnpm add stellate

Imports

Stellate
wrong
```
import Stellate from 'stellate'
```
correct
```
import { Stellate } from 'stellate'
```
The package exports a named class, not a default export. TypeScript types are bundled.
runStellate
wrong
```
const runStellate = require('stellate')
```
correct
```
import { runStellate } from 'stellate'
```
ESM-only package; require() will fail. Use dynamic import if needed.
StellateConfig
```
import type { StellateConfig } from 'stellate'
```
Type-only import for TypeScript users. Importing as value will cause runtime error.

Quickstart

Initializes the Stellate client with an API key and lists all services.

import { Stellate } from 'stellate';

const stellate = new Stellate({ apiKey: process.env.STELLATE_API_KEY ?? '' });

async function listServices() {
  const services = await stellate.list();
  console.log(services);
}

listServices().catch(console.error);