swelog-cli

Description

swelog-cli is a Rust CLI for tracking daily accomplishments in Obsidian.

The tool creates a small set of Markdown files in your Obsidian vault. Collect raw work notes throughout the day, and use LLMs to summarize the notes into a daily work log.

Then, aggregate the daily logs into a weekly log for more long-term tracking.

Installation

Install with npm:

npm install -g swelog-cli

Usage

Getting Started

• Run swelog init to create a default config file

• Update the config file with your Obsidian vault path and model provider

• Run swelog setup to create the default swelog files in your Obsidian vault

• Update the context file with information about your role, team, and current priorities

Daily Workflow

• Add notes throughout the day with swelog log "Meeting with manager" or manually in Obsidian

• Run swelog fetch github to fetch your GitHub PR activity and add it to your work file

• Run swelog summarize or swelog summarize day to generate a daily log

• Run swelog summarize week to generate a weekly log

Other

• un swelog reset to reset your work file to its default content

Configuration

AI Summarization

By default, swelog uses Ollama:

{
  "llm": "ollama",
  "ollamaModel": "llama3.2"
}

To use OpenAI instead, set the provider and model in your config:

{
  "llm": "openAi",
  "openAiModel": "gpt-5.4-mini"
}

Then provide your OpenAI API key through the environment before running swelog summarize:

export OPENAI_API_KEY="your_api_key_here"

Do not store your OpenAI API key in the swelog config file.

GitHub Integration

To fetch your GitHub PR activity and add it to your work file, you need to provide your GitHub token.

export GITHUB_TOKEN="your_github_token_here"

Do not store your GitHub token in the swelog config file.

Contributing

Prerequisites

Please have the following installed on your machine:

• Rust
• Just
• Ollama, when using the default Ollama provider
• Obsidian

Development

Run the binary locally:

just run --help

Format the workspace:

just format

Build the workspace:

just build

Run all tests:

just test

Run Clippy:

just clippy

Run the full pull request check:

just pr

Pull Request Process

Branch protections are enabled on this repository.

To contribute, please create a new branch and make a pull request.

The rules for branch names are lax, just be sure to include your name.

An example branch name for a change that adds weekly log generation would be:

rudra-weekly-log-generation

Your pull request title must follow the conventional commits specification. An example of a valid pull request title is:

feat: Add weekly log generation

All PRs must pass just pr, which checks formatting, linting, and tests.