JSON mode

JSON mode is for scripts and integrations. Turn it on in createCLI(), then store one final value with cli.setResult().

Enable JSON mode

import { createCLI } from "@oscli-dev/oscli";

export const cli = createCLI((b) => ({
  description: "json demo",
  json: true,
  prompts: {
    name: b.text().label("Name").default("my-app"),
  },
}));

await cli.run(async () => {
  await cli.prompt.name();
  cli.setResult({ name: cli.storage.name, created: true });
});

What changes under --json

Use --json only when you want raw output for another process.

bun run src/cli.ts

bun run src/cli.ts --json

• Normal run: prompts, logs, intro, outro, boxes, progress, and success lines render normally
• JSON run: only the value from cli.setResult() is printed

Minimal diff

This is the only code you need to add to support JSON mode.

export const cli = createCLI((b) => ({
  description: "json demo",
  prompts: {
    name: b.text().label("Name"),
  },
  json: true, 
}));

await cli.run(async () => {
  await cli.prompt.name();
  cli.setResult({ name: cli.storage.name }); 
});

Reference