Skip to content

A daily reporting tool that intelligently summarizes into longer term achievements.

Notifications You must be signed in to change notification settings

eric-sims/reporter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

reporter

A CLI tool to capture daily summaries and generate weekly summaries, using a locally running Ollama LLM. Written in Golang.

AI Documentation (via DeepWiki)

I just found this DeepWiki documentation site and decided to feed it my repo. Check it out!

Features

  • Save a summary for today or a specific date
  • Aggregate a given week (or current week) and ask a large language model to summarize
  • List reports for a given day or week
  • reporter help for a usage instructions.
  • CLI logic handled by CobraCLI
  • SQLite storage interfaced with GORM (DB file: ~/.config/reporter/data.db)
  • Configurable LLM models for Ollama, ability to access OpenAI API

Installation

Installation is available through go install:

go install github.com/eric-sims/reporter@latest

Connect to Ollama

Instructions for installing Ollama, finding models and serving it locally.

Set these environment variables (or flags):

OLLAMA_HOST or flag --ollama (default: http://127.0.0.1:11434)
OLLAMA_MODEL or flag --model (default: gpt-oss:20b)

Connect to OpenAI API

Note

This is different than the consumer ChatGPT subscription. This is a separate dev account separate pricing structures. Learn more about it here.

Generate an api key here, then save it to the environment variable:

OPENAI_API_KEY or flag --openai-api-key

Upcoming features

  • Connect to ChatGPT API (user-provided api key)
  • Dump prompt to stdout so a user can copy/paste to any model.
  • Tag projects to entries
  • Easily add git-hooks to repositories to log commits

About

A daily reporting tool that intelligently summarizes into longer term achievements.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages