shipi | docs

Output Formats

Markdown (default)

shipi generate
## What's New
- Added dark mode toggle
- Improved search performance

JSON

shipi generate --format json
{
  "version": "v2.4.0",
  "date": "2024-01-15",
  "changes": [
    {
      "type": "feature",
      "description": "Added dark mode toggle",
      "tickets": ["FEAT-892"]
    },
    {
      "type": "improvement",
      "description": "Improved search performance",
      "tickets": ["PERF-201"]
    }
  ]
}

JSON output is useful for:

  • Feeding into other tools
  • Custom formatting
  • API integrations

Plain text

shipi generate --format text
What's New
- Added dark mode toggle
- Improved search performance

Output to file

Combine with -o to write to a file:

shipi generate --format json -o release.json