DocsGetting StartedQuick Start

Get started with Duitar

Generate your first AI-powered release notes in under 60 seconds.

You need a Duitar API key. Sign up at duitar.dev to get one.

1

Connect your repo

Authorize Duitar to read your repository. We use GitHub OAuth so we never store your credentials directly.

connect.ts
// Redirect the user to GitHub OAuth
import { Duitar } from "duitar"

const client = new Duitar({ 
  apiKey: process.env.DUITAR_API_KEY
})

// Generate the OAuth URL for the user
const authUrl = await client.repos.connect({
  provider: "github",
  redirectUri: "https://app.example.com/callback"
})

console.log(authUrl)
// => https://github.com/login/oauth/authorize?client_id=...
2

Generate release notes

Run a single CLI command to analyze your commits and generate human-readable release notes powered by AI.

terminal
# Generate release notes for tag v1.0.0
$ npx duitar generate v1.0.0

# Output:
  Analyzing 47 commits...
  Detected 12 features, 8 fixes, 3 breaking changes
  Generating release notes...

  Release notes generated successfully.
  Preview: https://duitar.dev/preview/rn_abc123
3

Publish

Publish your release notes to every channel at once — GitHub Releases, Slack, email, your docs site, or anywhere via webhooks.

publish.ts
// Publish to all configured targets
const result = await client.releases.publish({
  releaseId: "rn_abc123",
  targets: ["github", "slack", "email"],
  audience: "external"
})

console.log(result.published)
// => { github: true, slack: true, email: true }

Next up