summaraizer #

Summarizes comments from a variety of sources, such as GitHub issues, Slack threads, Reddit posts, and more using AI models from different providers, such as Ollama, OpenAI, and more.

CLI #

Installation #

  • Download pre-built binaries from the releases page
  • Install via go toolchain:
go install github.com/ioki-mobility/summaraizer/cmd/summaraizer@latest

Source vs Summarization #

The CLI is split up into two parts. The source part and the summarization part. First you need to fetch comments from a source, then you can summarize the comments.

Of course, you can also do both independently.

Source aka. fetching comments #

The general usage is:

summaraizer [SOURCE] [ARGUMENTS]

Example sources are:

  • github
  • gitlab
  • slack
  • reddit

The source writes to Stdout and writes the output in a JSON format:

[
    {
        "author": "Author1",
        "body": "Body1"
    },
    {
        "author": "Author2",
        "body": "Body2"
    }
]

Summarization aka. calling providers #

The general usage is:

summaraizer [PROVIDER] [ARGUMENTS]

Example providers are:

  • ollama
  • anthropic
  • openai
  • google

The provider reads from Stdin and requires a special JSON format as input:

[
    {
        "author": "Author1",
        "body": "Body1"
    },
    {
        "author": "Author2",
        "body": "Body2"
    }
]

Tips and tricks #

Custom source

Using a provider to summarize from a custom¹ source:

echo '[{"author": "Author1", "body": "I like to"}, {"author": "Author2", "body": "Move it!"}]' | summaraizer ollama

¹: Custom source means that you can provide your own comments in the JSON format.

Custom prompt

Customize the prompt to fit your needs, using Go templates:

summaraizer github --issue ioki-mobility/summaraizer/1 | summaraizer ollama --prompt 'Please count the comments in the following discussion.\nEach comment is divided into a <comment> tag.\nHere is the discussion:\n{{ range $comment := . }}\n<comment>{{ $comment.Body }}</comment>\n{{end}}'

The prompt will receive a struct in form of Comments, with the following structure:

type Comments []Comments

type Comment struct {
    Author string
    Body   string
}

Go module #

Installation # 

go get github.com/ioki-mobility/summaraizer@latest

Example # 

package main

import (
	"bytes"
	"fmt"
	"log"
	
	"github.com/ioki-mobility/summaraizer"
)

func main() {
	buffer := bytes.Buffer{}
	gh := summaraizer.GitHub{
		RepoOwner:   "ioki-mobility",
		RepoName:    "summaraizer",
		IssueNumber: "1",
	}
	err := gh.Fetch(&buffer)
	if err != nil {
		log.Fatal(err)
	}

	openAi := summaraizer.OpenAi{
		Model:    "gpt-4o-mini",
		Prompt:   "A prompt that can make use of templates. See the Comments type",
		ApiToken: "API-TOKEN",
	}
	summarization, err := openAi.Summarize(&buffer)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(summarization)
}