@dawn-ai/cli
v0.8.26
Published
Command-line development, testing, build, and runtime tools for Dawn applications.
Maintainers
Readme
@dawn-ai/cli
Command-line development tools and runtime embedding entry points for Dawn applications.
Use this when: You are developing, checking, testing, building, serving, or embedding a Dawn runtime.
Install
Requires Node.js 24 or later. Install the CLI as a development dependency for normal application workflows:
pnpm add -D @dawn-ai/cliInstall it as a production dependency only when application code imports its runtime entry points.
Example
Use the local binary to develop, validate, test, and build an application:
pnpm exec dawn dev
pnpm exec dawn check
pnpm exec dawn test
pnpm exec dawn buildThe corresponding commands are dawn dev, dawn check, dawn test, and dawn build when the local binary is already on PATH.
To let application code own a production Node listener, import serveRuntime from the package root:
import { serveRuntime } from "@dawn-ai/cli"
const runtime = await serveRuntime({
appRoot: process.cwd(),
host: "0.0.0.0",
port: 8000,
})
console.log(runtime.url)
// Call await runtime.close() during your host's ordered shutdown.Runtime and stability
@dawn-ai/cliand itsdawncommand are supported node-only application and tooling surfaces.@dawn-ai/cli/fetchis a supported edge-safe integration surface for generated fetch deployments.@dawn-ai/cli/runtimeis Node-only and low-level.@dawn-ai/cli/testingis a deprecated, back-compat-only node-only alias of@dawn-ai/sdk/testing; it remains supported only for existing imports, and new scenario code should use the SDK subpath.
serveRuntime() starts once and does not watch files or run type generation at boot. Use dawn dev for the development watcher and generated types.
Related
@dawn-ai/sdksupplies the route and runtime contracts consumed by the CLI.@dawn-ai/coreprovides the route discovery, configuration, and type-generation primitives used by the CLI.- CLI guide
- CLI API reference
- Embed the runtime
- Deployment options
@dawn-ai/clichangelog
Maturity and support
Dawn is pre-1.0, and its public surface can change. All publishable Dawn packages release together as a fixed group; review the @dawn-ai/cli changelog and upgrading guide before upgrading. For support, use GitHub Discussions; report defects in GitHub Issues.
License
MIT. See the repository license.
