@tiey/synth 0.0.1

package/README.md

@@ -0,0 +1,75 @@
+# Synth
+
+Synth is a TypeScript CLI for collecting AI coding sessions from local tools, summarizing them with an LLM, and generating scheduled daily reports on Windows.
+
+## Features
+
+- Collect sessions from Claude Code, Codex, and Qoder.
+- Summarize sessions through OpenAI-compatible or Anthropic models.
+- Generate Markdown and HTML reports under `~/.synth/reports/`.
+- Run manually with `synth run` or as a Windows service with cron scheduling.
+
+## Install
+
+```bash
+npm install
+npm run build
+```
+
+For global CLI testing:
+
+```bash
+npm link
+synth config --init
+```
+
+Published package name:
+
+```bash
+npm install -g @tiey/synth
+```
+
+## Configuration
+
+Synth reads configuration from `~/.synth/config.yaml`.
+
+Minimal example:
+
+```yaml
+llm:
+  provider: "openai-compatible"
+  baseUrl: "https://api.openai.com/v1"
+  apiKey: "your-api-key"
+  model: "gpt-4o"
+```
+
+## Common Commands
+
+```bash
+synth run
+synth run --since 2026-04-01
+synth run --date 2026-04-05
+synth status
+synth install
+```
+
+## Development
+
+```bash
+npm run typecheck
+npm run build
+npm run pack:check
+npx tsx test-collect.ts
+npx tsx test-summarize.ts
+```
+
+## Release
+
+See `docs/NPM_PUBLISH.md` for npm release steps and `scripts/publish-npm.ps1` for the local release helper.
+
+## Distribution Notes
+
+- npm packaging is ready through `dist/` plus `README.md`.
+- Windows service support depends on `node-windows`.
+- This version does not support notification delivery channels.
+- SEA packaging is not wired yet. The current build still relies on external runtime assumptions such as `better-sqlite3` and `node-windows`, so SEA should be treated as a follow-up task rather than a release path today.