@tanagram/lore 0.1.87 → 0.1.89

package/README.md

@@ -1,28 +1,77 @@
-# `@tanagram/lore`
+# Lore
 
-The command-line interface for Lore.
+Lore captures your Claude Code, Codex, and Cowork sessions and turns them
+into something your team can search, discuss, and build on.
 
-## Privacy: Lore uploads according to your local filters
+Your AI coding sessions run on your machine. The Lore CLI watches for new
+ones and uploads them to your workspace automatically, so there is no
+copy-paste, no screenshots, no "save this thread" button to remember.
+
+## Get started
+
+```sh
+npm install -g @tanagram/lore
+lore
+```
+
+`lore` opens a dashboard in your terminal. Sign in there once and, on
+macOS, background uploads start immediately. On Linux, run `lore configure`
+to pick which directories upload.
+
+That's it. Keep coding. New sessions show up in your workspace automatically.
+
+## How privacy works
+
+**Private by default.** Every session starts visible only to you. You
+choose per session whether to share it with your workspace or make it
+public. Workspace admins cannot override that choice.
+
+**You control what uploads.** Lore only uploads sessions from directories
+you allowlist. The first-run wizard pre-checks your three most recent
+projects; nothing outside your allowlist is ever sent. Re-run the picker
+any time with `lore configure`, or edit the list directly:
+
+```sh
+lore listen list                    # what's currently allowlisted
+lore listen create ~/code/project   # start uploading from here
+lore listen delete ~/code/project   # stop
+```
+
+**What a session contains.** Your prompts, the assistant's responses,
+tool calls, file edits, and diffs, plus metadata like timestamps, model,
+and the repo it ran in. Diffs include the changed lines of the files you
+edited. Lore does not collect environment variables, secrets, or API keys.
+
+**Stop anytime.** `lore disable` halts background uploads. `lore logout`
+removes your stored credentials. You can delete any session, or your whole
+account, from the web app.
+
+---
+
+## Reference: upload filters
 
 The Lore daemon evaluates `~/.lore/upload_filters.json` (`~/.lore-dev/`
 in dev) before auto-uploading Claude Code sessions. Missing config or an
-empty `include` allowlist means upload nothing. Non-empty `include`
-dimensions (`cwd`, `repo`, `skills`) are ANDed together, values within a
-dimension are ORed, and `exclude` rules override includes.
+empty `include` allowlist means upload nothing. The `cwd` and `repo`
+allowlists are a union: a session is location-allowed if it matches a
+`cwd` rule OR a `repo` rule (so a non-git directory uploads via its `cwd`
+even when `repo` rules also exist). When set, `include.skills` further
+narrows that set (ANDed). Values within a dimension are ORed, and
+`exclude` rules override includes.
 
 The explicit commands (`lore export`, `lore share-codex`,
 `lore share-cowork`) are user-initiated and upload the requested session
 directly.
 
-Adding directories through the TUI is a convenience for writing cwd
-include filters. The post-login wizard shows your most-recent Claude Code
-project cwds with the top three pre-checked, and pressing Enter accepts
-them. `lore listen configure` re-enters that same interactive flow any
-time (it's also one of the quick actions on the `lore` dashboard). For
+Adding repos and directories through the TUI is a convenience for writing
+`repo` and `cwd` include filters. The post-login wizard shows your
+most-recent Claude Code projects with the top three pre-checked: a project
+inside a git repo is offered as its `origin` remote, and a non-repo
+directory is offered by its path. Pressing Enter accepts them. `lore configure` re-enters that same interactive flow any time
+(it's also one of the quick actions on the `lore` dashboard). For
 scripted/non-interactive edits, manage the cwd filters directly:
 
 ```sh
-lore listen configure                         # re-run the interactive wizard
 lore listen create ~/code/projectA            # watch ~/code/projectA
 lore listen create ~/work --workspace acme          # route work to a non-default workspace
 lore listen list                              # tabular output
@@ -76,8 +125,8 @@ through Ink in TTY mode:
   device code panel → polling), then a success box with the resolved
   LaunchAgent paths. Distinct copy for timed-out / denied / expired.
   On first login the device-code flow is followed by a one-screen
-  "Configure upload directories" wizard that can write cwd include
-  filters for users who prefer a directory allowlist workflow.
+  "Configure uploads" wizard that writes `repo` and `cwd` include
+  filters from your recent repos and directories.
 - **`lore enable` / `disable` / `restart`** — spinner with mode-specific
   copy while launchctl works, then a success or error MessageBox.
 - **`lore status`** — two-panel view (health on the left, paths on the
@@ -143,8 +192,8 @@ Esc to return to the sidebar, and q to exit.
 - `lore disable` — stops and removes the macOS background uploader.
 - `lore restart` — restarts the macOS background uploader.
 - `lore status` / `lore status --json` — shows background uploader health.
-- `lore listen configure` — re-enter the interactive wizard for picking
-  the directories Lore auto-uploads from (the same flow shown on first
+- `lore configure` — re-enter the interactive wizard for picking the
+  directories Lore auto-uploads from (the same flow shown on first
   login). Requires an interactive terminal.
 - `lore listen create <path> [--workspace <name>]` — allowlist a directory for
   daemon auto-uploads. Defaults to your active workspace; pass workspace
@@ -161,7 +210,9 @@ Esc to return to the sidebar, and q to exit.
   JSON object with the thread URL. Use `--session-id <id>` to pick a specific
   session, `--project <path>` to override the project lookup, and
   `--visibility private|workspace|public` to set the resulting thread's
-  visibility. The URL is also copied to the system clipboard when a clipboard
+  visibility. Use `--highlight <description>` to have the API resolve a
+  natural-language share highlight and return a `/thread/<id>#tb_…` block
+  anchor or range when it finds a match. The URL is also copied to the system clipboard when a clipboard
   tool is available (`pbcopy` / `wl-copy` / `xclip` / `xsel` / `clip.exe`).
 - `lore share-cowork` — shares a Claude Cowork local-agent-mode session
   to Lore. Defaults to the current session when run from inside one
@@ -171,7 +222,7 @@ Esc to return to the sidebar, and q to exit.
   Use `--session <session-id>` to share a specific session by id, or
   `--list` to enumerate local sessions newest-first without sharing.
   Re-running for the same session converges to the same thread (md5
-  dedup), so it's safe to retry. Prints the resulting `/session/<id>`
+  dedup), so it's safe to retry. Prints the resulting `/thread/<id>`
   URL on success.
 
 ## Dev vs prod