code2cast

Appearance

Getting Started ​

Quick start ​

The fastest way to start is with npx:

sh
npx code2cast init

This launches an interactive wizard that walks you through project setup.

Installation ​

If you prefer a global install:

sh
npm install -g code2cast

Or with your package manager of choice:

sh
npm install -g code2cast
sh
pnpm add -g code2cast
sh
yarn global add code2cast

Initialise a project ​

Run the init command in your project directory:

sh
cd my-project
code2cast init

The wizard will ask you for:

  1. Project name — used as the podcast series title
  2. Description — a short summary of what the project does
  3. Theme — the tone of the podcast (casual, technical, entertaining, or executive)
  4. Duration — target episode length in minutes

This creates a code2cast.config.json in your project root.

Non-interactive mode ​

For CI pipelines or AI agents, skip the wizard:

sh
code2cast init --yes --name "My Project" --theme technical

Add --json for machine-readable output:

sh
code2cast init --json --yes --name "My Project"

Next steps ​