CLI

The asc command compiles .as files using your project's Atscript configuration.

Usage

npx asc [options]

Options

Option	Description
-c, --config <path>	Path to config file. If omitted, auto-detects atscript.config.{js,mjs,cjs,ts,mts,cts} walking up from the CWD (JS variants are checked first in each directory).
-f, --format <format>	Output format (dts or js). If omitted, the TypeScript plugin emits .d.ts (its default branch); pass -f js to get .js output.
--noEmit	Run diagnostics only, don't write files
--skipDiag	Skip diagnostics, always emit files
--help	Display help

Examples

# Generate .d.ts files (default)
npx asc

# Generate .js files with runtime metadata
npx asc -f js

# Use a specific config file
npx asc -c path/to/atscript.config.ts

# Validate without writing files (CI/lint check)
npx asc --noEmit

# Emit without running diagnostics
npx asc --skipDiag

The CLI logs created files, errors, and warnings with color-coded output. It exits with code 1 if any errors are found (unless --skipDiag is set).

TIP

If no config file is found, the CLI still runs with the TypeScript plugin enabled and emits .d.ts — so npx asc works out of the box.

Database Schema Sync

The CLI also includes a db sync command for synchronizing your database schema with your .as definitions.

INFO

The db sync subcommand is bundled with @atscript/typescript so that a single asc binary covers both codegen and schema sync, but it drives adapters from the separate @atscript/db-* packages — the adapter (@atscript/db-sqlite, @atscript/db-mongo, …) must be installed and referenced from the config's db section for this command to do anything. Full reference at db.atscript.dev.

npx asc db sync [options]

Option	Description
-c, --config <path>	Path to config file
--dry-run	Show planned changes without applying
--yes	Skip confirmation prompt (for CI/CD)
--force	Re-sync even if schema hash matches
--safe	Skip destructive operations (drops)

# Preview changes
npx asc db sync --dry-run

# Auto-approve for CI
npx asc db sync --yes

# Safe mode — only additive changes
npx asc db sync --safe

This requires a db section in your config:

export default defineConfig({
  // ...
  db: {
    adapter: '@atscript/db-sqlite',
    connection: './myapp.db',
  },
})

See the Schema Sync guide for full documentation.

Next Steps

• Configuration — config file options
• Build Setup — bundler integration
• Schema Sync — database migration guide