aptu-core 0.2.1

Core library for Aptu - OSS issue triage with AI assistance
Documentation

Aptu (Mi'kmaq): "Paddle" - Navigate forward through open source contribution

Demo

Aptu Demo

Features

  • GitHub OAuth - Secure device flow authentication (or use existing gh CLI auth)
  • Issue Discovery - Find "good first issue" from curated repositories
  • AI Triage - Get summaries, suggested labels, clarifying questions, and contributor guidance via OpenRouter
  • Flexible Issue References - Triage by URL, short form (owner/repo#123), or bare number
  • Already-Triaged Detection - Automatically detects if you've already triaged an issue
  • Triage Flags - Control behavior with --dry-run, --yes, --since
  • Multiple Output Formats - Text, JSON, YAML, and Markdown output
  • Local History - Track your contributions offline

Installation

# Homebrew (recommended)
brew tap clouatre-labs/tap
brew install aptu

# Or via cargo-binstall (fast, ~5 seconds)
cargo binstall aptu

# Or from crates.io (~2-3 minutes)
cargo install aptu

# Or build from source
git clone https://github.com/clouatre-labs/aptu.git
cd aptu && cargo build --release

Quick Start

aptu auth login                                                    # Authenticate with GitHub
aptu repo list                                                     # List curated repositories
aptu issue list block/goose                                        # Browse issues
aptu issue triage https://github.com/block/goose/issues/123       # Triage with AI
aptu issue triage https://github.com/block/goose/issues/123 --dry-run  # Preview
aptu history                                                       # View your contributions

GitHub Action

Automatically triage new issues using the Aptu GitHub Action. Create .github/workflows/triage.yml:

name: Triage New Issues
on:
  issues:
    types: [opened]
jobs:
  triage:
    runs-on: ubuntu-latest
    permissions:
      issues: write
      contents: read
    steps:
      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
      - uses: clouatre-labs/aptu@v0
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          openrouter-api-key: ${{ secrets.OPENROUTER_API_KEY }}

See docs/GITHUB_ACTION.md for detailed inputs documentation.

Configuration

See docs/CONFIGURATION.md for detailed AI provider setup and configuration options.

Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines on how to contribute, including our Developer Certificate of Origin (DCO) requirement. Whether you're interested in adding new AI models, building the iOS app, enhancing the CLI, writing documentation, reporting bugs, or spreading the word - all contributions are welcome!

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.