Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.edgespark.dev/llms.txt

Use this file to discover all available pages before exploring further.

Run edgespark --help for a list of all commands, or edgespark <command> --help for detailed options and flags.

​
Account and project setup

CommandDescription
edgespark loginStart browser-based authentication and store local credentials
edgespark whoamiShow the current authenticated user
edgespark logoutClear stored credentials
edgespark init <name> —agent <name>Create a new EdgeSpark project and write the matching instructions file
edgespark init <name> —agent <name> -t <src>Initialize from a template — official shorthand, github:owner/repo, tarball URL, SSH URL, or local path
edgespark init now scaffolds a root project with server/, web/, configs/, and edgespark.toml. Install dependencies separately in server/ and web/ after scaffolding. --agent is required. The current mappings are:
  • claude writes CLAUDE.md
  • gemini writes GEMINI.md
  • codex writes AGENTS.md
  • Any other agent name also writes AGENTS.md
That means values such as copilot, cursor, opencode, amp, devin, aider, windsurf, cline, continue, antigravity, kiro, or your own custom agent name all currently scaffold AGENTS.md.

​
Local development

CommandDescription
edgespark devStart the local dev server on http://localhost:7775
edgespark dev --port <number>Run the dev server on a different port
edgespark dev --resetWipe .edgespark/state/ before starting so seed data and migrations re-run

​
Deploy

CommandDescription
edgespark deployBuild and deploy your project to its current default environment
edgespark deploy --dry-runRun deployment validation before a real deploy

​
Custom domains

See the custom domains guide for the end-to-end flow.
CommandDescription
edgespark domain add <hostname>Register a hostname against the current project and print the DNS records to publish
edgespark domain verify <hostname>Poll until the domain is active or the timeout is reached (default 15m, configurable with --timeout)
edgespark domain status <hostname>One-shot read of activation, EdgeSpark routing, TLS status, and any pending DNS records
edgespark domain listList every custom domain on the current project
edgespark domain remove <hostname>Detach a hostname from the current project
New projects currently expose one default production environment. Public staging and promote workflows are coming soon, so they are intentionally not documented here yet.

​
Logs

CommandDescription
edgespark log tailStream real-time logs from your current default environment

​
Pull platform-managed files

CommandDescription
edgespark pullPull platform-managed schema and SDK types together
edgespark pull schemaPull system-managed database tables into server/src/__generated__/
edgespark pull typesPull SDK type declarations for edgespark imports
edgespark pull types --checkCheck whether generated SDK types are stale without writing files
Use edgespark pull to refresh everything that EdgeSpark generates for you. It does not replace your app schema workflow in server/src/defs/. For your own tables, use edgespark db generate and edgespark db migrate.

​
Database

CommandDescription
edgespark db generateGenerate migration files from server/src/defs/db_schema.ts
edgespark db generate —name <name>Generate a named migration
edgespark db migrateApply pending migrations to the project database
edgespark db migrate --confirm-dangerousApply pending migrations that include destructive SQL
edgespark db checkValidate the local migration chain before deploy
edgespark db studioOpen Drizzle Studio against the project database
edgespark db studio —port <port>Run Drizzle Studio on a custom port
edgespark db studio —host <host>Bind Drizzle Studio to a custom host
edgespark db sql "<query>"Run an ad-hoc SQL query against the project database
edgespark db sql "<query>" --confirm-dangerousAllow destructive DML such as DELETE after explicit confirmation
edgespark db sql is for reads and ad-hoc DML. DDL such as CREATE TABLE, ALTER TABLE, and DROP TABLE is blocked. Use the migration workflow instead.

​
Storage

CommandDescription
edgespark storage applyApply bucket declarations from server/src/defs/storage_schema.ts
edgespark storage apply --confirm-dangerousConfirm bucket removals before applying
edgespark storage bucket listList synced storage buckets
edgespark storage bucket list --descInclude bucket descriptions in the output

​
Secrets

CommandDescription
edgespark secret listList secret names only
edgespark secret set <keys…>Register one or more secret keys and open a secure page for entering values
edgespark secret delete <keys…>Delete one or more secret keys
edgespark secret set never sends secret values through the terminal, agent context, or third-party LLM APIs such as Anthropic, Google, or OpenAI. The CLI only registers key names, then opens a secure EdgeSpark browser URL where the human owner enters the values directly.

​
Vars

CommandDescription
edgespark var listList configured environment variables
edgespark var set <entries…>Set one or more plain env vars in KEY=VALUE form
edgespark var delete <keys…>Delete one or more env vars by key

​
Auth configuration

CommandDescription
edgespark auth getShow the current auth configuration
edgespark auth get --jsonShow the current auth configuration as JSON
edgespark auth pullPull auth config into configs/auth-config.yaml
edgespark auth applyApply configs/auth-config.yaml to the project
edgespark auth apply updates the project config, but you should still run edgespark deploy before expecting auth changes to affect your live app.

​
See also

CLI installation

How to install and authenticate the EdgeSpark CLI.

Deploy and test loop

How to use edgespark deploy and edgespark log tail in the development loop.

The deploy pipeline

What happens at each step when you run edgespark deploy.

Declarative workflow

How repo-authored schema, pull commands, and generated types fit together.
Last modified on April 30, 2026