@redaksjon/protokoll 0.0.11 → 0.0.13

package/guide/configuration.md

@@ -8,40 +8,29 @@
 # Model settings
 model: "gpt-5.2"                   # Reasoning model (default)
 transcriptionModel: "whisper-1"    # Audio transcription
-
-# Context
-context:
-  directory: "~/.protokoll"
-  autoCreate: true
-
-# Routing
-routing:
-  default:
-    path: "~/notes"
-    structure: "month"
-    filename:
-      - date
-      - time
-      - subject
-  
-  projects:
-    - projectId: "work"
-      destination:
-        path: "~/work/notes"
-        structure: "month"
-      triggers:
-        - "work note"
-        - "about work"
-
-# Output
-output:
-  intermediateDir: "./output/protokoll"
-  keepIntermediates: true
-
-# Features
-features:
-  interactive: false               # Disabled by default
-  selfReflection: true            # Enabled by default
+reasoningLevel: "medium"           # Reasoning effort: low, medium, high (default: medium)
+
+# Directory settings (Dreadcabinet options)
+inputDirectory: "./recordings"      # Where to find audio files
+outputDirectory: "~/notes"          # Where to write transcripts
+outputStructure: "month"            # Directory structure (none, year, month, day)
+outputFilenameOptions:              # Filename components
+  - date
+  - time
+  - subject
+
+# Processing options
+processedDirectory: "./processed"   # Move processed audio here (optional)
+
+# Features (flat properties, not nested)
+interactive: true                   # Interactive prompts (enabled by default)
+selfReflection: true               # Generate reflection reports (enabled by default)
+silent: false                      # Sound notifications (enabled by default)
+
+# Advanced
+maxAudioSize: 26214400             # Max audio file size in bytes (25MB)
+tempDirectory: "/tmp"              # Temporary file storage
+contextDirectories: []             # Additional context locations
 ```
 
 ## Environment Variables
@@ -60,17 +49,19 @@ features:
 | Option | Description | Default |
 |--------|-------------|---------|
 | `--input-directory <dir>` | Directory with audio files | Required |
-| `--output-directory <dir>` | Default output directory | `~/notes` |
+| `--output-directory <dir>` | Default output directory | `./` |
 | `--model <model>` | Reasoning model | `gpt-5.2` |
 | `--transcription-model <model>` | Whisper model | `whisper-1` |
+| `--reasoning-level <level>` | Reasoning effort (low/medium/high) | `medium` |
 
 ### Mode Options
 
 | Option | Description | Default |
 |--------|-------------|---------|
-| `--interactive` | Enable interactive clarifications | `false` |
+| `--batch` | Disable interactive mode | `false` (interactive enabled) |
 | `--self-reflection` | Generate reflection reports | `true` |
 | `--no-self-reflection` | Disable reflection reports | - |
+| `--silent` | Disable sound notifications | `false` |
 | `--dry-run` | Show what would happen | `false` |
 | `--verbose` | Enable verbose logging | `false` |
 | `--debug` | Enable debug mode | `false` |
@@ -85,7 +76,7 @@ features:
 | `--processed-directory <dir>` | Move processed files here | - |
 | `--overrides` | Allow config overrides | `false` |
 
-## Routing Structures
+## Output Structures
 
 Protokoll uses Dreadcabinet structure codenames:
 
@@ -120,6 +111,43 @@ Protokoll walks up the directory tree looking for `.protokoll/` directories:
 
 Lower directories take precedence for conflicting settings.
 
+## Project-Based Routing
+
+Routing to different destinations is configured via **project files** in the context system, not in the main config.yaml.
+
+### Example Project File
+
+```yaml
+# ~/.protokoll/projects/work.yaml
+id: work
+name: Work Notes
+type: project
+
+classification:
+  context_type: work
+  explicit_phrases:
+    - "work note"
+    - "about work"
+    - "office meeting"
+  topics:
+    - "standup"
+    - "sprint"
+
+routing:
+  destination: "~/work/notes"
+  structure: "month"
+  filename_options:
+    - date
+    - time
+    - subject
+  auto_tags:
+    - work
+
+active: true
+```
+
+See [Context System](./context-system.md) and [Routing](./routing.md) for more details.
+
 ## Model Selection
 
 ### Reasoning Models
@@ -152,48 +180,35 @@ Lower directories take precedence for conflicting settings.
 
 ```yaml
 model: "gpt-5.2"
-routing:
-  default:
-    path: "~/notes"
-    structure: "month"
+outputDirectory: "~/notes"
+outputStructure: "month"
 ```
 
-### Work Projects
+### Work Setup with Processed Directory
 
 ```yaml
 model: "claude-3-5-sonnet"
-routing:
-  default:
-    path: "~/notes/personal"
-    structure: "month"
-  projects:
-    - projectId: "work"
-      destination:
-        path: "~/work/notes"
-        structure: "day"
-      triggers:
-        - "work"
-        - "office"
-        - "meeting"
+inputDirectory: "~/recordings"
+outputDirectory: "~/notes"
+outputStructure: "month"
+processedDirectory: "~/recordings/processed"
+selfReflection: true
 ```
 
-### Team Shared Context
+### Batch Processing (Non-Interactive)
 
 ```yaml
-# ~/team-project/.protokoll/config.yaml
-context:
-  directory: "./.protokoll"
-routing:
-  default:
-    path: "./notes"
-    structure: "month"
+# For automation/cron jobs
+interactive: false
+selfReflection: false
 ```
 
-### Batch Processing (No Self-Reflection)
+### Team Shared Context
 
 ```yaml
-features:
-  selfReflection: false
-  interactive: false
+# ~/team-project/.protokoll/config.yaml
+# Uses relative path for team portability
+outputDirectory: "./notes"
+outputStructure: "month"
 ```