@franshjy/dbrief 0.1.0 → 0.2.0

package/README.md

@@ -1,7 +1,7 @@
 # Dbrief
 
 Dbrief extracts daily session activity into artifacts for generating Markdown daily notes.
-Currently only support Codex, with Opencode and Claude Code support on the way.
+The extractor currently supports Codex and Opencode session data (Claude on the way). The final note output is plain Markdown. 
 
 ## How does Dbrief work?
 
@@ -10,6 +10,8 @@ You can install the skill to the agent of your choice, and you can either:
 - Edit the skill to modify the location, writing style, or note layout
 - Or just use it directly with the default layout.
 
+When no `--source` is provided, Dbrief auto-discovers supported local sources that have readable local state.
+
 ## Installation
 
 ```bash
@@ -22,10 +24,10 @@ npm install -g @franshjy/dbrief
 cd ~/your-project
 dbrief install              # Install dbrief-note skill
 dbrief extract              # Extract today's sessions
-codex "Generate my daily note from dbrief_2026-06-04.json"
+$dbrief_note
 ```
 
-The CLI produces the JSON artifact. Codex uses the installed skill to turn that artifact into a portable Markdown note with `Summary`, `Projects`, and `Other` sections.
+The CLI produces the JSON artifact. Your coding agent uses the installed `dbrief-note` skill to turn that artifact into a Markdown note with `Summary`, `Projects`, and `Other` sections.
 
 ## Commands
 
@@ -39,6 +41,9 @@ dbrief extract --date 2026-06-01            # Specific date -> ./dbrief_2026-06-
 dbrief extract --from 2026-05-01            # From date to today
 dbrief extract --to 2026-06-01              # From earliest to date
 dbrief extract --from 2026-05-01 --to 2026-06-01  # Date range -> current directory by default
+dbrief extract --source codex               # Codex only
+dbrief extract --source opencode           # Opencode only
+dbrief extract --source codex,opencode     # Explicit merged sources
 dbrief extract --out ./output.json          # Custom output path
 ```
 
@@ -47,11 +52,16 @@ dbrief extract --out ./output.json          # Custom output path
 - `--from <date>`: Start date for range extraction
 - `--to <date>`: End date for range extraction
 - `--out <path>`: Output file (single day) or directory (range)
-- `--codex-dir <path>`: Codex data directory (default: ~/.codex)
+- `--source <source>`: Enable session source(s): `codex`, `opencode`
+- `--codex-dir <path>`: Codex data directory (default: `~/.codex`)
+- `--opencode-dir <path>`: Opencode data directory (default: `~/.local/share/opencode`)
+
+Notes:
+- Source merge is the default behavior when multiple supported local sources are discovered.
 
 ### install
 
-Install the dbrief-note skill to `.codex/skills/dbrief-note/` in the current directory. The skill currently writes Markdown only and is currently only installed on Codex, though you can manually install the skill on any coding agent you want.
+Install the dbrief-note skill to `.codex/skills/dbrief-note/` in the current directory. The skill writes Markdown only. Dbrief does not include note-app adapters or native app APIs in this release.
 
 ```bash
 dbrief install
@@ -78,21 +88,21 @@ Output is minified JSON. Messages are tuples of `["u"|"a", content_string]`.
 
 ```json
 {
-  "date": "2026-06-04",
+  "date": "2026-06-01",
   "timezone": "Asia/Bangkok",
   "projects": [
     {
-      "project_key": "C:/dev/projects/codex-trails",
+      "project_key": "project-alpha",
       "threads": [
         {
-          "title": "How does codex store compressed context?",
+          "title": "Daily note output contract",
           "branch": "master",
           "context": [],
           "messages": [
-            ["u", "How does codex store compacted context?"],
-            ["a", "Three compaction paths exist: local, remote v1, remote v2..."],
-            ["u", "Can I extract the summary from JSONL?"],
-            ["a", "Only `replacement_history` is persisted. The summary is ephemeral."]
+            ["u", "Why did you modify the mapper of the user table?"],
+            ["a", "Whoopsies!"],
+            ["u", "tf?"],
+            ["a", "My bad g"]
           ]
         }
       ]
@@ -105,9 +115,14 @@ Output is minified JSON. Messages are tuples of `["u"|"a", content_string]`.
 - **Full** (no compaction): `context` = `[]`, `messages` = all messages
 - **Hybrid** (compacted): `context` = replacement_history, `messages` = post-compaction messages
 
-## Note Writing Contract
+**Current source behavior:**
+- **Codex**: Reads thread metadata from `state_5.sqlite` and transcript content from JSONL rollout files.
+- **Opencode**: Reads session, message, and part data from `opencode.db`, flattening visible user/assistant text only.
+- 
+## Note Writing Structure
 
-The primary output of `dbrief extract` is JSON. The final daily note is generated by Codex using the installed `dbrief-note` skill.
+The primary output of `dbrief extract` is JSON. The final daily note is generated by the installed `dbrief-note` skill.
+You can override the default structure by editing the skill. The writer should also preserve an existing note structure when updating an existing file.
 
 The default Markdown structure is:
 
@@ -126,7 +141,7 @@ The default Markdown structure is:
 ```bash
 npm install
 npm run build
-npm link (to access the dbrief command)
+npm link
 ```
 
 ## License