From cfd8e6cfde5e966c07f1ff26612121519323fd05 Mon Sep 17 00:00:00 2001 From: Adeel Ahmad Date: Sun, 11 Oct 2026 02:47:29 +0000 Subject: [PATCH] docs: list Telegram, Slack, file shares, cloud model presets and the monitoring switch as built "Ask" names the built-in Telegram bot (#293) and Slack app (#287); "Connect your agents" adds mounting the graph's files read-only over S3, WebDAV, NFS or SMB (#324, #295, #305) and copying the MCP address from the account menu (#340); "Watch it run" says one switch in the web app starts Prometheus and Grafana (#337); "Light by default" adds the cloud model presets (#334). The docs index gains the NFS and SMB pages, and "In progress" keeps only open PRs. Co-Authored-By: Claude Opus 5.5 (1M context) Claude-Session: https://claude.ai/code/session_01HDx7PPUauyjMn1LZs8JAsS --- README.md | 44 +++++++++++++++++++++----------------------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 33ed1357f..6de69e95d 100644 --- a/README.md +++ b/README.md @@ -59,13 +59,16 @@ Everything below is built and merged. Work that is still in a pull request is li - **Connect your agents.** Lens is an MCP server (`/mcp`): agents search, read transcripts and notes, cite exact moments, find similar content, explore the graph with Cypher or SPARQL or browse it as folders and files, suggest topics and graph changes, write notes and make podcasts. They sign in with OAuth and see only what their person may - read. The web app runs on the same REST API, so an agent can do what a person can. ([MCP](docs/mcp.md), - [API](docs/api.md), [the graph as files](docs/file-tree.md), [authentication](docs/authentication.md)) + read; the account menu copies the MCP address in one click. The same folders and files can be mounted read-only over + S3, WebDAV, NFS or SMB, so file managers and scripts read Lens too. The web app runs on the same REST API, so an + agent can do what a person can. ([MCP](docs/mcp.md), [API](docs/api.md), [the graph as files](docs/file-tree.md), + [authentication](docs/authentication.md)) - **Ask, and get cited answers.** A chat assistant on every page, and by voice, searches your archive by words (and by meaning, once turned on), reads it, cites it and acts on it with tools: changes wait for your approval. It reads answers aloud with a speech provider, macOS `say` or StyleTTS2 on this machine (opt-in), and `/clear` and `/compact` keep long conversations short. Each namespace can have its own assistant with its own name, instructions - and memory, answering in Slack, Discord, Telegram, Matrix, WhatsApp and other chat rooms through Matterbridge. + and memory, answering in Telegram and Slack (built in, with voice notes and files), and in Discord, Matrix, + WhatsApp and other chat rooms through Matterbridge. ([Chat](docs/assistant.md), [chat rooms](docs/chat-rooms.md), [speech providers](docs/speech-providers.md)) - **Extend the assistant.** Add tools (a prompt, a web request, a graph drawn on the canvas, or sandboxed Python), skills, hooks and remote MCP servers, by code, on the canvas or just by asking. Install skills and plugins from @@ -107,9 +110,9 @@ Everything below is built and merged. Work that is still in a pull request is li copy each one, encrypted, to a storage connection. ([Updates and backups](docs/updates.md), [backups](docs/database.md#backups)) - **Watch it run.** OpenTelemetry traces and metrics, and a Prometheus `/metrics` endpoint. Both are off until you - turn them on, and send nothing anywhere else. An opt-in `monitoring` profile runs Prometheus, node-exporter and - Grafana next to Lens, already connected, with the Lens dashboard as Grafana's home. ([Telemetry](docs/telemetry.md), - [Prometheus](docs/prometheus.md)) + turn them on, and send nothing anywhere else. On a Docker install, one switch in the web app (or one API call from + an agent) starts Prometheus, node-exporter and Grafana next to Lens, already connected, with the Lens dashboard as + Grafana's home. ([Telemetry](docs/telemetry.md), [Prometheus](docs/prometheus.md)) - **Stay private and safe.** Passkeys instead of passwords, encryption at rest with a key per namespace, roles per namespace, and an audit log. Prompt injection meets several layers: what the assistant reads (recordings, documents, web pages, tool results) reaches the model marked as data, not instructions, and text that reads like @@ -128,21 +131,19 @@ Everything below is built and merged. Work that is still in a pull request is li ## Light by default Lens runs on a small machine. Heavy parts (local speech models, a local LLM, document conversion, Fedora) stay off or -download only when you turn them on, and any of them can be swapped for a cloud provider instead. Every setting lives -in the web app. ([Components](docs/components.md), [speech providers](docs/speech-providers.md), -[local models](docs/local-models.md)) +download only when you turn them on, and any of them can be swapped for a cloud provider instead. Picking a cloud +model provider in setup or Settings fills in its address and a model, so only its key is left to paste. Every setting +lives in the web app. ([Components](docs/components.md), [speech providers](docs/speech-providers.md), +[local models](docs/local-models.md), [cloud model providers](docs/configuration.md#cloud-model-providers)) ## In progress These are open pull requests, not yet part of Lens: -- **Chat channels:** a built-in Telegram bot on a shared channel layer - ([#293](https://github.com/adeelahmad/lense/pull/293)) and a Slack app over Socket Mode - ([#287](https://github.com/adeelahmad/lense/pull/287)), without Matterbridge; and the assistant's own email address, - over IMAP and SMTP ([#314](https://github.com/adeelahmad/lense/pull/314)). +- **Email:** the assistant's own email address, over IMAP and SMTP + ([#314](https://github.com/adeelahmad/lense/pull/314)). - **Assistant safety:** running MCP servers that are programs (stdio) in a sandbox ([#304](https://github.com/adeelahmad/lense/pull/304)). -- **Cloud model presets** in Settings and the setup wizard ([#334](https://github.com/adeelahmad/lense/pull/334)). - **Search:** a Similar tab, and similar content for text selected anywhere ([#307](https://github.com/adeelahmad/lense/pull/307)); NSFW pictures classified by a local model, per namespace ([#306](https://github.com/adeelahmad/lense/pull/306)). @@ -151,16 +152,13 @@ These are open pull requests, not yet part of Lens: - **Running it:** an upgrade page with live steps that rolls back when the new version doesn't start ([#262](https://github.com/adeelahmad/lense/pull/262)), HTTPS set up in Settings ([#326](https://github.com/adeelahmad/lense/pull/326)), structured logs with a log viewer and syslog output - ([#284](https://github.com/adeelahmad/lense/pull/284)), built-in usage analytics - ([#274](https://github.com/adeelahmad/lense/pull/274)), and turning Prometheus and Grafana on from the web app - ([#337](https://github.com/adeelahmad/lense/pull/337)). + ([#284](https://github.com/adeelahmad/lense/pull/284)), and built-in usage analytics + ([#274](https://github.com/adeelahmad/lense/pull/274)). - **People:** email invitations, and removing someone for good ([#286](https://github.com/adeelahmad/lense/pull/286)). - **Lens.app for macOS:** a menu-bar app that carries microsandbox ([#280](https://github.com/adeelahmad/lense/pull/280)). -- **The graph as files, shared:** read-only over S3 and WebDAV ([#324](https://github.com/adeelahmad/lense/pull/324)), - SMB ([#305](https://github.com/adeelahmad/lense/pull/305)) and NFS - ([#295](https://github.com/adeelahmad/lense/pull/295)); assets and people rather than recordings and speakers, unless - it is audio ([#273](https://github.com/adeelahmad/lense/pull/273)). +- **Assets and people** rather than recordings and speakers, unless it is audio + ([#273](https://github.com/adeelahmad/lense/pull/273)). - **Reading documents** with an Apache Tika server ([#292](https://github.com/adeelahmad/lense/pull/292)). ## Stack @@ -187,8 +185,8 @@ The guides are on the [docs site](https://adeelahmad.github.io/lense/) and in th [the assistant in your browser](docs/browser-assistant.md), [sensors](docs/sensors.md), [processing](docs/processing.md), [video](docs/video.md), [notifications](docs/notifications.md) - **Knowledge:** [graph and Cypher](docs/graph.md), [graph history](docs/graph-history.md), [topics](docs/topics.md), - [the graph as files](docs/file-tree.md), [linked data (RDF)](docs/rdf.md), [IIIF](docs/iiif.md), - [Fedora](docs/fedora.md) + [the graph as files](docs/file-tree.md), [NFS share](docs/file-shares.md), [SMB share](docs/smb.md), + [linked data (RDF)](docs/rdf.md), [IIIF](docs/iiif.md), [Fedora](docs/fedora.md) - **Models and cost:** [local models](docs/local-models.md), [speech providers](docs/speech-providers.md), [activity and costs](docs/activity.md), [budgets](docs/budgets.md) - **Operate:** [encryption](docs/encryption.md), [storage](docs/storage.md), [database](docs/database.md),