@redaksjon/protokoll 0.4.3 → 1.0.1

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.
@@ -0,0 +1,57 @@
1
+ # protokoll_get_version
2
+
3
+ Get the current version of Protokoll including git information and system details.
4
+
5
+ ## Purpose
6
+
7
+ This tool is useful for diagnosing if you are using the latest version of Protokoll. It returns detailed version information including:
8
+ - Package version
9
+ - Git branch and commit
10
+ - Git commit date
11
+ - System platform, architecture, and Node.js version
12
+
13
+ ## Parameters
14
+
15
+ None required.
16
+
17
+ ## Returns
18
+
19
+ ```typescript
20
+ {
21
+ version: string; // Full version string with git and system info
22
+ programName: string; // "protokoll"
23
+ fullVersion: string; // "protokoll <version>"
24
+ }
25
+ ```
26
+
27
+ ## Example Output
28
+
29
+ ```json
30
+ {
31
+ "version": "1.0.1-dev.0 (working/de9eb6d 2026-01-27 10:55:39 -0800) darwin arm64 v24.8.0",
32
+ "programName": "protokoll",
33
+ "fullVersion": "protokoll 1.0.1-dev.0 (working/de9eb6d 2026-01-27 10:55:39 -0800) darwin arm64 v24.8.0"
34
+ }
35
+ ```
36
+
37
+ ## Usage
38
+
39
+ Call this tool whenever you need to verify which version of Protokoll is running, especially when:
40
+ - Troubleshooting issues
41
+ - Verifying you have the latest changes
42
+ - Reporting bugs
43
+ - Checking if a feature is available in your version
44
+
45
+ ## Version String Format
46
+
47
+ The version string follows this format:
48
+ ```
49
+ <package-version> (<git-branch>/<git-commit> <commit-date>) <platform> <arch> <node-version>
50
+ ```
51
+
52
+ Example breakdown:
53
+ - `1.0.1-dev.0` - Package version from package.json
54
+ - `working/de9eb6d` - Git branch and short commit hash
55
+ - `2026-01-27 10:55:39 -0800` - Commit timestamp with timezone
56
+ - `darwin arm64` - Operating system and architecture
57
+ - `v24.8.0` - Node.js version
package/guide/index.md CHANGED
@@ -190,6 +190,12 @@ export OPENAI_API_KEY="sk-..."
190
190
  export ANTHROPIC_API_KEY="sk-ant-..."
191
191
  ```
192
192
 
193
+ ### System Requirements
194
+
195
+ - **Node.js 18+** and **npm 9+**
196
+ - **ffmpeg** for audio format conversion (install with `brew install ffmpeg`, `apt-get install ffmpeg`, or from [ffmpeg.org](https://ffmpeg.org))
197
+ - **OpenAI API key** (required for transcription)
198
+
193
199
  ## For AI Assistants
194
200
 
195
201
  If you're an AI helping someone use Protokoll:
@@ -6,10 +6,26 @@ Get Protokoll working in 5 minutes.
6
6
 
7
7
  - Node.js 18+
8
8
  - npm 9+
9
+ - ffmpeg (for audio format conversion)
9
10
  - OpenAI API key
10
11
 
11
12
  ## Installation
12
13
 
14
+ ### 1. Install ffmpeg
15
+
16
+ ```bash
17
+ # macOS
18
+ brew install ffmpeg
19
+
20
+ # Ubuntu/Debian
21
+ sudo apt-get install ffmpeg
22
+
23
+ # Windows
24
+ # Download from https://ffmpeg.org/download.html
25
+ ```
26
+
27
+ ### 2. Install Protokoll
28
+
13
29
  ```bash
14
30
  npm install -g @redaksjon/protokoll
15
31
  ```
@@ -34,7 +50,16 @@ export OPENAI_API_KEY='sk-...'
34
50
  export ANTHROPIC_API_KEY='sk-ant-...'
35
51
  ```
36
52
 
37
- ### 2. Create Config (optional)
53
+ ### 2. Verify ffmpeg Installation
54
+
55
+ ```bash
56
+ ffmpeg -version
57
+ # Should show version info
58
+ ```
59
+
60
+ If you see "command not found", make sure ffmpeg is installed and in your PATH.
61
+
62
+ ### 3. Create Config (optional)
38
63
 
39
64
  ```bash
40
65
  mkdir -p ~/.protokoll
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redaksjon/protokoll",
3
- "version": "0.4.3",
3
+ "version": "1.0.1",
4
4
  "description": "Focused audio transcription with intelligent context integration",
5
5
  "main": "dist/main.js",
6
6
  "type": "module",
@@ -22,7 +22,7 @@
22
22
  "lint": "eslint . --ext .ts",
23
23
  "lint:fix": "eslint . --ext .ts --fix",
24
24
  "clean": "rm -rf dist",
25
- "precommit": "npm run lint && npm run test && npm run mcp:test",
25
+ "precommit": "npm run lint && npm run build && npm run test && npm run mcp:test",
26
26
  "prepublishOnly": "npm run clean && npm run build",
27
27
  "mcp:build": "npm run build && echo 'MCP server built'",
28
28
  "mcp:inspect": "npm run build && npx @modelcontextprotocol/inspector dist/mcp/server.js",
@@ -45,9 +45,11 @@
45
45
  "@anthropic-ai/sdk": "^0.71.2",
46
46
  "@google/generative-ai": "^0.24.1",
47
47
  "@modelcontextprotocol/sdk": "^1.25.2",
48
+ "@redaksjon/context": "^0.0.3",
48
49
  "@riotprompt/riotprompt": "^0.0.21",
49
50
  "@theunwalked/cardigantime": "^0.0.22",
50
51
  "@theunwalked/dreadcabinet": "^0.0.15",
52
+ "@theunwalked/overcontext": "^0.0.3",
51
53
  "@types/fluent-ffmpeg": "^2.1.28",
52
54
  "cli-table3": "^0.6.5",
53
55
  "commander": "^14.0.2",
@@ -0,0 +1,16 @@
1
+ {
2
+ "choices": [
3
+ {
4
+ "message": {
5
+ "content": "**Weekly Summary: Week 4, 2026**\n\n**Overview:** \nThis week focused on resolving technical issues within the project, particularly related to model configurations and documentation updates. Significant progress was made in bug fixes and enhancing the build process.\n\n**Key Accomplishments:** \n- Resolved a critical bug concerning the model default configuration in the kronologi system.\n- Ensured built files have the correct executable permissions.\n- Updated and clarified documentation regarding the configuration hierarchy, improving overall project clarity.\n\n**Progress:** \n- Initiated testing of the newly implemented weekly summary functionality, with early results showing promise.\n- Made advancements in verifying improvements to the build process, contributing to more efficient workflows.\n\n**Decisions:** \n- It was decided to prioritize the testing of the weekly summary feature to ensure its reliability before further rollout.\n\n**Challenges:** \n- No significant blockers were reported this week; however, ongoing testing may reveal unforeseen issues that will need to be addressed.\n\n**Next Steps:** \n- Complete testing of the weekly summary functionality and gather feedback for any necessary adjustments.\n- Finalize verification of the build process improvements and implement any outstanding changes identified during testing.\n- Continue monitoring for potential issues during the implementation of updates. \n\nThis summary encapsulates the key activities and progress made during the week and sets the stage for continued advancements in the upcoming week."
6
+ },
7
+ "finish_reason": "stop"
8
+ }
9
+ ],
10
+ "usage": {
11
+ "prompt_tokens": 331,
12
+ "completion_tokens": 269,
13
+ "total_tokens": 600
14
+ },
15
+ "model": "gpt-4o-mini"
16
+ }
@@ -0,0 +1,60 @@
1
+ {
2
+ "config": {
3
+ "model": "gpt-4o-mini",
4
+ "temperature": 0.7,
5
+ "maxCompletionTokens": 4000,
6
+ "parameters": {
7
+ "year": {
8
+ "type": "number",
9
+ "description": "Year for the summary",
10
+ "required": true
11
+ },
12
+ "month": {
13
+ "type": "number",
14
+ "description": "Month number (1-12) - used as week identifier for weekly summaries",
15
+ "required": true
16
+ }
17
+ },
18
+ "context": {},
19
+ "content": {
20
+ "activity": {
21
+ "type": "activity",
22
+ "name": "Weekly Activity",
23
+ "directory": "",
24
+ "pattern": "*.md"
25
+ }
26
+ },
27
+ "output": {
28
+ "summary": {
29
+ "type": "summary",
30
+ "format": "markdown",
31
+ "name": "Weekly Summary",
32
+ "pattern": "summary.md"
33
+ },
34
+ "completion": {
35
+ "type": "metadata",
36
+ "format": "json",
37
+ "pattern": "completion.json"
38
+ },
39
+ "inputs": {
40
+ "type": "metadata",
41
+ "format": "json",
42
+ "pattern": "inputs.json"
43
+ }
44
+ },
45
+ "name": "weekly-summary"
46
+ },
47
+ "request": {
48
+ "model": "gpt-4o-mini",
49
+ "messages": [
50
+ {
51
+ "role": "system",
52
+ "content": "<Weekly Summary Persona>\nYou are a professional technical writer who creates concise, informative weekly summaries.\n\nYour summaries:\n\n- Highlight key accomplishments and progress\n- Identify important decisions and changes\n- Note blockers or challenges\n- Are written in clear, professional language\n- Focus on what matters most to stakeholders\n</Weekly Summary Persona>"
53
+ },
54
+ {
55
+ "role": "user",
56
+ "content": "<Context>\n\n</Context>\n\n<Weekly Summary Instructions>\nCreate a comprehensive weekly summary based on the provided activity files.\n\n<Structure>\n- **Overview**: Brief summary of the week's focus and major themes\n- **Key Accomplishments**: What was completed or achieved\n- **Progress**: Work that advanced significantly\n- **Decisions**: Important decisions made\n- **Challenges**: Blockers or issues encountered\n- **Next Steps**: Planned work for the coming week\n</Structure>\n\n<Guidelines>\n- Be concise but informative\n- Use bullet points for easy scanning\n- Highlight the most important items\n- Include relevant context for decisions\n- Note any risks or concerns\n- Keep the tone professional and factual\n</Guidelines>\n</Weekly Summary Instructions>\n\n<Content>\n<Weekly Activity Content>\n<activity/2026/4/test-activity.md>\n# Test Activity for Week 4, 2026\n\n## Completed Tasks\n- Fixed model default configuration bug in kronologi\n- Added executable permissions to built files\n- Updated documentation for configuration hierarchy\n\n## In Progress\n- Testing weekly summary functionality\n- Verifying build process improvements\n\n</activity/2026/4/test-activity.md>\n</Weekly Activity Content>\n</Content>"
57
+ }
58
+ ]
59
+ }
60
+ }
@@ -0,0 +1,26 @@
1
+ **Weekly Summary: Week 4, 2026**
2
+
3
+ **Overview:**
4
+ This week focused on resolving technical issues within the project, particularly related to model configurations and documentation updates. Significant progress was made in bug fixes and enhancing the build process.
5
+
6
+ **Key Accomplishments:**
7
+ - Resolved a critical bug concerning the model default configuration in the kronologi system.
8
+ - Ensured built files have the correct executable permissions.
9
+ - Updated and clarified documentation regarding the configuration hierarchy, improving overall project clarity.
10
+
11
+ **Progress:**
12
+ - Initiated testing of the newly implemented weekly summary functionality, with early results showing promise.
13
+ - Made advancements in verifying improvements to the build process, contributing to more efficient workflows.
14
+
15
+ **Decisions:**
16
+ - It was decided to prioritize the testing of the weekly summary feature to ensure its reliability before further rollout.
17
+
18
+ **Challenges:**
19
+ - No significant blockers were reported this week; however, ongoing testing may reveal unforeseen issues that will need to be addressed.
20
+
21
+ **Next Steps:**
22
+ - Complete testing of the weekly summary functionality and gather feedback for any necessary adjustments.
23
+ - Finalize verification of the build process improvements and implement any outstanding changes identified during testing.
24
+ - Continue monitoring for potential issues during the implementation of updates.
25
+
26
+ This summary encapsulates the key activities and progress made during the week and sets the stage for continued advancements in the upcoming week.