Your first document with the CLI

Start after installing the CLI. This guide makes a small presentation and exports a PDF.

Call the CLI from your own application

You can invoke WworPoint’s CLI from a custom GUI or LLM-connected tool to incorporate document generation, validation and export. An external tool writes and saves sources; your application runs wwpo validate / wwpo export as separate processes. WworPoint itself includes no LLM connection.

Select the project with --project <dir> and inspect the --json response (apiVersion: 1) and exit code. Exit codes are 0 success, 1 error, 2 export blocked by warnings, 64 invalid arguments, 70 internal error and 130 interruption. Handle ok, summary, diagnostics and outputs, and confirm generated output before presenting the result in your GUI.

See the public CLI contract and JSON response. This is process invocation, not a promise that internal packages form a stable SDK. The npm package is not yet public; current installation uses a supplied test artifact.

Check the license terms for WworPoint and bundled libraries when using, modifying or distributing them. See the current licensing explanation and pending release terms, and assess the requirements for your own use and distribution model.

Draft together. Let AI shape the design.

Ask familiar external tools such as ChatGPT, Claude or Gemini to draft and refine Markdown, CSV, CSS and diagram sources. WworPoint includes no AI model, automatic connection, built-in integration or AI credits. Share the generated agent guide with your chosen tool and apply the files yourself.

People review facts, evidence and design. Layout validation cannot guarantee factual accuracy or aesthetic quality. Review Git diffs and the actual PDF, then refine the files.

1. Create a project

wwpo init my-deck --mode presentation
cd my-deck

Init creates document.md, .wworpoint/project.json, design/theme.css and an agent guide. It never overwrites existing files.

2. Write two slides

Replace the contents of document.md with:

# Our next step

A short proposal for the team.

---

## Start small

- Agree on one goal
- Make a working example
- Review the result together

3. Preview

wwpo preview

Open the local URL printed by the CLI in Chrome or Edge. Saved changes refresh the preview. Keep the terminal running; press Ctrl+C to stop before continuing.

4. Save and validate

wwpo validate

Validation checks saved sources and layout in the export browser. Fix errors and review warnings.

5. Export

wwpo export
wwpo export --format html

The default destinations are dist/<name>.pdf and dist/<name>.html. Errors block export; warnings also block the CLI unless you explicitly pass --allow-warnings after reviewing them.

Prefer a report?

Create another project with wwpo init my-report --mode paged. Use <!-- wwpo:break --> for a new section on a new page. See the A4 example.