swelog-cli 0.6.0 → 0.7.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.
- package/README.md +58 -13
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -49,31 +49,54 @@ npm install -g swelog-cli
|
|
|
49
49
|
|
|
50
50
|
### Other
|
|
51
51
|
|
|
52
|
-
-
|
|
52
|
+
- Run `swelog reset` to reset your work file to its default content
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
- Run `swelog config` to display your current configuration and where it is stored
|
|
55
55
|
|
|
56
|
-
|
|
56
|
+
## Configuration
|
|
57
57
|
|
|
58
|
-
|
|
58
|
+
`swelog init` writes a config file to your OS config directory at
|
|
59
|
+
`swelog/swelog.json` (for example `~/.config/swelog/swelog.json` on Linux). The
|
|
60
|
+
default config looks like this:
|
|
59
61
|
|
|
60
62
|
```json
|
|
61
63
|
{
|
|
64
|
+
"obsidianVaultPath": "",
|
|
65
|
+
"swelogFolderName": "swelog",
|
|
66
|
+
"workFileName": "WORK.md",
|
|
67
|
+
"contextFileName": "CONTEXT.md",
|
|
68
|
+
"dailyLogFolderName": "Daily",
|
|
69
|
+
"weeklyLogFolderName": "Weekly",
|
|
62
70
|
"llm": "ollama",
|
|
63
|
-
"
|
|
71
|
+
"llmModel": "llama3.2"
|
|
64
72
|
}
|
|
65
73
|
```
|
|
66
74
|
|
|
67
|
-
|
|
75
|
+
Every field is described below. All of the swelog files and folders live inside
|
|
76
|
+
`<obsidianVaultPath>/<swelogFolderName>`.
|
|
68
77
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
78
|
+
| Field | Description |
|
|
79
|
+
| --- | --- |
|
|
80
|
+
| `obsidianVaultPath` | Absolute path to your Obsidian vault. Empty by default; you must set this before running other commands, otherwise swelog errors out. |
|
|
81
|
+
| `swelogFolderName` | Name of the folder created inside your vault that holds all swelog files. |
|
|
82
|
+
| `workFileName` | Name of the file where you collect raw daily work notes. |
|
|
83
|
+
| `contextFileName` | Name of the file holding context about your role, team, and priorities, which is fed to the LLM during summarization. |
|
|
84
|
+
| `dailyLogFolderName` | Name of the folder (inside the swelog folder) where generated daily logs are stored. |
|
|
85
|
+
| `weeklyLogFolderName` | Name of the folder (inside the swelog folder) where generated weekly logs are stored. |
|
|
86
|
+
| `llm` | LLM provider used for summarization. One of `ollama`, `openAi`, or `openRouter`. |
|
|
87
|
+
| `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`. |
|
|
88
|
+
|
|
89
|
+
### AI Summarization
|
|
90
|
+
|
|
91
|
+
Configure your desired LLM provider and model in your config file.
|
|
92
|
+
|
|
93
|
+
#### Ollama
|
|
94
|
+
|
|
95
|
+
To use Ollama, ensure it is up and running at `localhost:11434` before running `swelog summarize`.
|
|
96
|
+
|
|
97
|
+
#### OpenAI
|
|
75
98
|
|
|
76
|
-
|
|
99
|
+
To use OpenAI, provide your OpenAI API key through the environment before running
|
|
77
100
|
`swelog summarize`:
|
|
78
101
|
|
|
79
102
|
```sh
|
|
@@ -82,6 +105,21 @@ export OPENAI_API_KEY="your_api_key_here"
|
|
|
82
105
|
|
|
83
106
|
Do not store your OpenAI API key in the swelog config file.
|
|
84
107
|
|
|
108
|
+
#### OpenRouter
|
|
109
|
+
|
|
110
|
+
To use OpenRouter, provide your OpenRouter API key through the environment before running
|
|
111
|
+
`swelog summarize`:
|
|
112
|
+
|
|
113
|
+
```sh
|
|
114
|
+
export OPENROUTER_API_KEY="your_api_key_here"
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Do not store your OpenRouter API key in the swelog config file.
|
|
118
|
+
|
|
119
|
+
`llmModel` must be an OpenAI model slug prefixed with `openai/` (for example
|
|
120
|
+
`openai/gpt-5.4-mini`), since swelog talks to OpenRouter using OpenAI's Responses API
|
|
121
|
+
format. Non-OpenAI models will not work.
|
|
122
|
+
|
|
85
123
|
### GitHub Integration
|
|
86
124
|
|
|
87
125
|
To fetch your GitHub PR activity and add it to your work file, you need to provide your GitHub token.
|
|
@@ -101,6 +139,7 @@ Please have the following installed on your machine:
|
|
|
101
139
|
- Rust
|
|
102
140
|
- Just
|
|
103
141
|
- Ollama, when using the default Ollama provider
|
|
142
|
+
- An OpenAI / OpenRouter API key, when using the OpenAI / OpenRouter provider
|
|
104
143
|
- Obsidian
|
|
105
144
|
|
|
106
145
|
### Development
|
|
@@ -141,6 +180,12 @@ Run the full pull request check:
|
|
|
141
180
|
just pr
|
|
142
181
|
```
|
|
143
182
|
|
|
183
|
+
Update the version of the CLI when preparing for a release:
|
|
184
|
+
|
|
185
|
+
```sh
|
|
186
|
+
just update-release-version <release-tag>
|
|
187
|
+
```
|
|
188
|
+
|
|
144
189
|
### Pull Request Process
|
|
145
190
|
|
|
146
191
|
Branch protections are enabled on this repository.
|