npm - swelog-cli - Versions diffs - 0.8.0 → 0.10.0 - Mend

swelog-cli 0.8.0 → 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/README.md +24 -187
package/package.json +1 -1

package/README.md CHANGED Viewed

@@ -1,210 +1,47 @@
-<!-- markdownlint-disable MD033-->
 # swelog-cli
-<h1 align="center">
-  <br>
-    <img src="./assets/repository-banner.png" alt="Repository Banner" width="20%">
-  <br>
-    swelog-cli
-</h1>
-## 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.
+Capture raw notes and optional integration activity throughout the day, summarize
+them into daily logs with an LLM, and combine daily logs into a weekly summary.
 ## Installation
-Install with npm:
+Install the CLI with npm:
 ```sh
 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
-- Run `swelog reset` to reset your work file to its default content
-- Run `swelog config` to display your current configuration and where it is stored
-## Configuration
-`swelog init` writes a config file to your OS config directory at
-`swelog/swelog.json` (for example `~/.config/swelog/swelog.json` on Linux). The
-default config looks like this:
-```json
-{
-  "obsidianVaultPath": "",
-  "swelogFolderName": "swelog",
-  "workFileName": "WORK.md",
-  "contextFileName": "CONTEXT.md",
-  "dailyLogFolderName": "Daily",
-  "weeklyLogFolderName": "Weekly",
-  "llm": "ollama",
-  "llmModel": "llama3.2"
-}
-```
-Every field is described below. All of the swelog files and folders live inside
-`<obsidianVaultPath>/<swelogFolderName>`.
-| Field | Description |
-| --- | --- |
-| `obsidianVaultPath` | Absolute path to your Obsidian vault. Empty by default; you must set this before running other commands, otherwise swelog errors out. |
-| `swelogFolderName` | Name of the folder created inside your vault that holds all swelog files. |
-| `workFileName` | Name of the file where you collect raw daily work notes. |
-| `contextFileName` | Name of the file holding context about your role, team, and priorities, which is fed to the LLM during summarization. |
-| `dailyLogFolderName` | Name of the folder (inside the swelog folder) where generated daily logs are stored. |
-| `weeklyLogFolderName` | Name of the folder (inside the swelog folder) where generated weekly logs are stored. |
-| `llm` | LLM provider used for summarization. One of `ollama`, `openAi`, or `openRouter`. |
-| `llmModel` | Model used for summarization, interpreted by whichever provider `llm` names. Examples: `llama3.2` for `ollama`, `gpt-5.4-mini` for `openAi`, `openai/gpt-5.4-mini` for `openRouter`. |
-### AI Summarization
-Configure your desired LLM provider and model in your config file.
-#### Ollama
-To use Ollama, ensure it is up and running at `localhost:11434` before running `swelog summarize`.
-#### OpenAI
-To use OpenAI, provide your OpenAI API key through the environment before running
-`swelog summarize`:
-```sh
-export OPENAI_API_KEY="your_api_key_here"
-```
-Do not store your OpenAI API key in the swelog config file.
-#### OpenRouter
-To use OpenRouter, provide your OpenRouter API key through the environment before running
-`swelog summarize`:
+Confirm the installation:
 ```sh
-export OPENROUTER_API_KEY="your_api_key_here"
+swelog --help
 ```
-Do not store your OpenRouter API key in the swelog config file.
+## Getting Started
-`llmModel` must be an OpenAI model slug prefixed with `openai/` (for example
-`openai/gpt-5.4-mini`), since swelog talks to OpenRouter using OpenAI's Responses API
-format. Non-OpenAI models will not work.
-### GitHub Integration
-To fetch your GitHub PR activity and add it to your work file, you need to provide your GitHub token.
-```sh
-export GITHUB_TOKEN="your_github_token_here"
-```
+Full documentation lives at
+**[the swelog docs site](https://swelog-cli.vercel.app/)**, including:
-Do not store your GitHub token in the swelog config file.
+- [Quick Start](https://swelog-cli.vercel.app/getting-started/quick-start/) —
+  configure your vault and record your first summarized day
+- [Configuration](https://swelog-cli.vercel.app/getting-started/configuration/)
+  — every field in `swelog.json`
+- [Summarization](https://swelog-cli.vercel.app/summarization/) — daily and
+  weekly logs, and the Ollama, OpenAI, and OpenRouter providers
+- [Integrations](https://swelog-cli.vercel.app/integrations/) — pull activity
+  from GitHub and Linear
+- [Authentication](https://swelog-cli.vercel.app/reference/authentication/) —
+  how credentials are stored and cleared
+- [Command reference](https://swelog-cli.vercel.app/reference/commands/) — the
+  full command tree
 ## Contributing
-### Prerequisites
+Source, issues, and contributing guidelines live on
+[GitHub](https://github.com/RudraPatel2003/swelog-cli).
-Please have the following installed on your machine:
-- Rust
-- Just
-- Ollama, when using the default Ollama provider
-- An OpenAI / OpenRouter API key, when using the OpenAI / OpenRouter provider
-- Obsidian
-### Development
-Run the binary locally:
-```sh
-just run --help
-```
-Format the workspace:
-```sh
-just format
-```
-Build the workspace:
-```sh
-just build
-```
-Run all tests:
-```sh
-just test
-```
-Run Clippy:
-```sh
-just clippy
-```
-Run the full pull request check:
-```sh
-just pr
-```
-Update the version of the CLI when preparing for a release:
-```sh
-just update-release-version <release-tag>
-```
-### 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:
-```text
-rudra-weekly-log-generation
-```
-Your pull request title must follow the conventional commits specification. An
-example of a valid pull request title is:
-```text
-feat: Add weekly log generation
-```
+## License
-All PRs must pass `just pr`, which checks formatting, linting, and tests.
+`swelog-cli` is released under the MIT License.

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "swelog-cli",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "A Rust CLI to track your daily accomplishments in Obsidian",
   "license": "MIT",
   "homepage": "https://github.com/RudraPatel2003/swelog-cli",