API reference
CLI programmatic API
Use the public parser and project or schematic generators from @aponiajs/cli.
Most users should call the aponia binary. Tooling integrations can import the
same public functions.
Public exports
| Kind | Exports |
|---|---|
| Functions | generateProject, generateSchematic, generateSchematics, parseArguments, runCli |
| Types | CliCommand, GenerateCommandOptions, GenerateProjectOptions, GenerateProjectResult, GenerateSchematic, GenerateSchematicOptions, GenerateSchematicResult, ResourceTransport, SchematicChange |
Argument parsing
import { parseArguments } from "@aponiajs/cli";
const command = parseArguments(["generate", "service", "users"]);Parsing throws on unknown commands, options, missing values, or extra positionals.
Project generation
import { generateProject } from "@aponiajs/cli";
const result = await generateProject({
name: "my-api",
cwd: process.cwd(),
dryRun: true,
skipInstall: false,
});Schematic generation
import { generateSchematic } from "@aponiajs/cli";
const result = await generateSchematic({
command: "generate",
schematic: "service",
name: "users",
dryRun: true,
skipImport: false,
crud: true,
type: "rest",
});runCli
import { runCli } from "@aponiajs/cli";
const exitCode = await runCli(["generate", "service", "users"]);runCli(arguments) returns 0 on success and 1 after printing a normalized
CLI error.