herdr-dashr 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Roland Czinege
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,177 @@
+# herdr-dashr
+
+A [Herdr](https://github.com/herdrdev/herdr) plugin that opens an
+**agent-built, live Grafana dashboard inside a Herdr pane**, with a coding
+agent underneath to reshape it.
+
+- **Real Grafana, in the terminal.** The top pane shows Grafana in kiosk mode
+  through [terminal-browser](https://github.com/zenbu-labs/terminal-browser);
+  without it, a text status view.
+- **No model in the data path.** Grafana refreshes the data. The agent only
+  changes the dashboard, through an MCP server.
+- **Privacy by construction.** The agent designs from schemas and masked
+  samples (`<email#1>`, `<ipv4#2>`); only you see real values.
+- **Disposable.** A pane-owned Grafana container with a read-only root and
+  tmpfs storage on a loopback port, removed when the pane closes.
+- **CodePipeline bootstrap.** Ctrl-click a CodePipeline URL: the plugin finds
+  the stacks it deployed and builds a first dashboard of their log groups,
+  queues and DLQs, state machines and Lambdas before the agent says a word.
+- **Saved dashboards.** Name a dashboard you like and reopen it in any later
+  pane.
+- **OpenTelemetry and live log checks.** One pane-owned container can also
+  receive OTLP logs, traces and metrics. Tell the agent which log messages
+  should fire (and which must not): the dashboard shows a tile per message
+  that turns green when it is logged, and a live log trail with the matches
+  highlighted.
+
+`docs/PRD.md` is the authoritative specification and delivery ledger.
+
+**Status:** v0.1.0, the first public release. All but one PRD requirement verified (the first npm publish comes with this release), most by an end-to-end
+suite that runs a real Herdr, a real Grafana and terminal-browser in CI.
+
+## Install
+
+```bash
+herdr plugin install czinegeroland/herdr-dashr
+```
+
+The build step installs the prebuilt `dashr` binary for your platform — from
+npm (`herdr-dashr`), whose platform packages were verified against the
+release's SHA-256 before they were packed; failing that from the GitHub
+release, verified the same way; and only as a last resort with `cargo`. No
+Rust toolchain is needed. `DASHR_INSTALL_SOURCE=npm|github|source` forces one. You need
+Docker. terminal-browser (for the real Grafana UI; it refuses to run as root), Claude Code (the chat
+pane) and the AWS CLI (CodePipeline, CloudWatch) are optional — run the
+**Check dashr prerequisites** action to see what is missing.
+
+### The CLI on its own
+
+```bash
+npx herdr-dashr@latest --version
+npm install -g herdr-dashr    # installs the `dashr` command
+```
+
+One npm package per platform carries the executable; npm installs only the
+one that runs on your machine, with no postinstall script and no download
+from GitHub.
+
+## Use
+
+| Action | What it does |
+|---|---|
+| **Open live dashboard** | New tab: Grafana on top, the agent underneath. |
+| **Open dashboard for a CodePipeline** | Ctrl-click a CodePipeline console URL. |
+| **Open live logs and traces (OpenTelemetry)** | Same tab, with an OTLP endpoint and a live log trail. |
+| **Promote dashboard to persistent Grafana** | Copies the focused session's dashboard (needs `[promote]`). |
+| **Check dashr prerequisites** | Doctor popup. |
+
+Close the dashboard pane to stop Grafana; the container, runtime files and
+browser profile are deleted. The sidebar token `$dashr` shows panel health
+(`6 ok · 1 err · 1 alert`).
+
+### Saved dashboards
+
+Like a dashboard? Tell the agent *"save this as checkout debug"*. It is kept
+on this machine (panels, queries and layout — never data). In any later pane,
+*"load checkout debug"* brings it back; the agent is told which dashboards are
+saved when it starts. From the command line:
+
+```bash
+dashr dashboards save "checkout debug"      # from the running session
+dashr dashboards list
+dashr dashboards load "checkout debug"      # into the running session
+dashr session start --load "checkout debug" # a new session showing it
+```
+
+A dashboard that uses a datasource the session lacks (say, the pipeline's
+CloudWatch in an OpenTelemetry pane) is refused, naming what is missing.
+
+### Live logs and log checks
+
+The OpenTelemetry action (or `[otel] enabled = true`) runs
+`grafana/otel-lgtm` instead of plain Grafana: still one container per pane,
+with Loki, Tempo and Prometheus behind an OTLP endpoint on loopback. What you
+send is queryable within about five seconds (traces in about two). Programs
+started from the chat pane find it in `OTEL_EXPORTER_OTLP_ENDPOINT`; anything
+else can be wrapped:
+
+```bash
+dashr tail -- cargo run --bin checkout     # output still on your terminal, exit code kept
+./app 2>&1 | dashr tail --service app
+```
+
+Then ask the agent: *"check that `order 42 created` and `payment captured` are
+logged and no exception is"*. It arms them (`expect_logs`), the dashboard gains
+a tile per message and a highlighted live trail, the pane notifies you as each
+arrives and turns blocked on a forbidden one, and the agent reads back a
+counts-only verdict. Without the agent:
+
+```bash
+dashr expect -p 'order created = order \d+ created' -p 'payment captured' -a 'exception'
+dashr expect --check    # exit status 0 when every expectation holds
+dashr expect --clear
+```
+
+The agent gets these MCP tools: `list_datasources`, `probe_query`,
+`apply_dashboard`, `panel_status`, `panel_data_sample`, `get_dashboard`,
+`watch_panel`, `list_watches`, `remove_watch`, `screenshot` (non-personal
+dashboards only), `open_for_pipeline`, `promote`.
+
+## The agent skill
+
+The plugin installs a **herdr-dashr skill** for Claude Code
+(`~/.claude/skills/herdr-dashr/`) that teaches the agent to build dashboards
+dynamically: turn the human's question into panels, probe the data, apply,
+verify with `panel_status`, and keep evolving the dashboard as the
+conversation goes. It carries dashboard-JSON rules, query models for every
+supported datasource (Prometheus, Loki, Tempo, CloudWatch, SQL Server, Azure
+Monitor, Zabbix, Seq, TestData) and debugging recipes (deploys, queue
+backlogs, Step Functions failures, error spikes, latency).
+
+- Installed by the plugin's build step, refreshed by the dashboard pane when
+  the binary is newer. A skill of the same name that you wrote is never
+  replaced (`--force` to override).
+- Also served as MCP resources (`dashr://guide/...`), so any MCP agent gets it.
+- `dashr skill files`, `dashr skill print reference/recipes.md`,
+  `dashr skill install --dir <skills-dir>`, `dashr skill uninstall`.
+- Configure with `agent.install_skill` and `agent.skill_dirs` in `dashr.toml`.
+
+## Configure
+
+`dashr config example` prints a commented `dashr.toml`; put it in the
+directory `herdr plugin config-dir herdr-dashr` prints. Datasources:
+Prometheus, Loki, Tempo, CloudWatch, SQL Server, Azure Monitor, Zabbix and Seq
+(the last two need `dashr image build`). Secrets are named by environment
+variable, never written into the file. Every datasource is personal unless
+you say `personal = false`.
+
+## Privacy
+
+- Every value an MCP tool returns passes through the masker: personal
+  field names are redacted; emails, IBANs, cards, IPs, phones, JWTs, AWS keys
+  and credentials inside other fields are replaced with stable pseudonyms.
+- `panel_status` reports rows and errors, never values. Watches are evaluated
+  by the pane; the agent never sees what it alerts on.
+- Grafana runs with a read-only root, tmpfs storage, no logs, no swap and no
+  capabilities, on loopback only. The browser profile lives in memory. In
+  OpenTelemetry mode, logs, traces and metrics are kept on disk in anonymous
+  Docker volumes that are deleted with the container.
+
+## Develop
+
+```bash
+cargo test --workspace
+cargo build && mkdir -p bin && cp target/debug/dashr bin/ && herdr plugin link "$PWD"
+scripts/e2e/run.sh            # real Herdr + real Grafana; needs Docker
+```
+
+Releases: dispatch the **Release** workflow from `main`; it builds the four
+platform archives with checksums and creates the `v<version>` tag. **Publish to
+npm** then runs automatically: it verifies every archive, builds the packages
+(`scripts/build-npm-packages.mjs`) and publishes them. It needs an
+`NPM_TOKEN` repository secret (an npm automation token); it can be re-run for
+any tag with a dry-run option.
+
+## License
+
+Apache-2.0

package/bin.js

@@ -0,0 +1,99 @@
+#!/usr/bin/env node
+// Resolves the prebuilt `dashr` for this platform and runs it.
+//
+// Ported from herdr-remote-channel's shim. The binary is not downloaded at
+// install time: each platform's executable is published inside its own npm
+// package, this package depends on all of them through
+// `optionalDependencies` with `os` and `cpu` constraints, and npm installs
+// exactly the one that can run here. npm serves the bytes under its own
+// integrity hash, and `scripts/build-npm-packages.mjs` checked each
+// executable against its published SHA-256 before packing it.
+
+import { spawn } from 'node:child_process'
+import { existsSync } from 'node:fs'
+import { createRequire } from 'node:module'
+import { fileURLToPath } from 'node:url'
+import { dirname, join, sep } from 'node:path'
+
+const require = createRequire(import.meta.url)
+const binary = 'dashr'
+
+// Keep in step with `scripts/build-npm-packages.mjs`, `scripts/install.sh`
+// and the release matrix; `crates/dashr-cli/tests/distribution.rs` holds them
+// together.
+const PACKAGES = {
+  'linux x64': 'linux-x64',
+  'linux arm64': 'linux-arm64',
+  'darwin x64': 'darwin-x64',
+  'darwin arm64': 'darwin-arm64',
+}
+
+// Run from `npm/dashr` inside a source checkout (a symlinked
+// `node_modules/herdr-dashr`), this file uses the checkout's own build in
+// `bin/`. An npm install never runs from `npm/dashr`: there it is a copy at
+// the package root.
+const here = dirname(fileURLToPath(import.meta.url))
+
+if (here.endsWith(`${sep}npm${sep}dashr`)) {
+  const local = join(here, '..', '..', 'bin', binary)
+  if (!existsSync(local)) {
+    console.error(
+      `dashr: this is a source checkout, but ${local} has not been built.\n` +
+        `Build it with: cargo build --release --locked --bin dashr && install -m 0755 target/release/dashr bin/dashr`,
+    )
+    process.exit(1)
+  }
+  run(local)
+} else {
+  run(published())
+}
+
+// The prebuilt executable npm installed for this platform.
+function published() {
+  const key = `${process.platform} ${process.arch}`
+  const suffix = PACKAGES[key]
+  if (!suffix) {
+    console.error(
+      `dashr: no prebuilt binary for ${key}.\n` +
+        `Supported: ${Object.keys(PACKAGES).join(', ')}.\n` +
+        `Build from source instead: cargo install --git https://github.com/czinegeroland/herdr-dashr dashr-cli`,
+    )
+    process.exit(1)
+  }
+  const pkg = `herdr-dashr-${suffix}`
+  try {
+    return require.resolve(`${pkg}/${binary}`)
+  } catch {
+    console.error(
+      `dashr: ${pkg} is not installed, so there is no binary for ${key}.\n` +
+        `If you installed with --no-optional, reinstall without it.`,
+    )
+    process.exit(1)
+  }
+}
+
+// Runs the executable in the foreground and exits the way it did.
+function run(resolved) {
+  // Asynchronous, so this process stays responsive to signals and forwards
+  // them: the dashboard pane stops its Grafana on SIGHUP, and a shim that
+  // swallowed it would leave the container running.
+  const child = spawn(resolved, process.argv.slice(2), { stdio: 'inherit' })
+
+  child.on('error', (error) => {
+    console.error(`dashr: could not run ${resolved}: ${error.message}`)
+    process.exit(1)
+  })
+
+  for (const signal of ['SIGTERM', 'SIGINT', 'SIGHUP']) {
+    process.on(signal, () => {
+      if (child.exitCode === null && child.signalCode === null) {
+        child.kill(signal)
+      }
+    })
+  }
+
+  child.on('exit', (status, signal) => {
+    const codes = { SIGHUP: 1, SIGINT: 2, SIGTERM: 15 }
+    process.exit(status === null ? 128 + (codes[signal] ?? 15) : status)
+  })
+}

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "herdr-dashr",
+  "version": "0.1.0",
+  "description": "Agent-built, live Grafana dashboards in a Herdr pane, with masking between your data and the agent.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/czinegeroland/herdr-dashr.git"
+  },
+  "homepage": "https://github.com/czinegeroland/herdr-dashr",
+  "keywords": [
+    "herdr",
+    "herdr-plugin",
+    "grafana",
+    "dashboard",
+    "mcp",
+    "observability"
+  ],
+  "type": "module",
+  "bin": {
+    "dashr": "bin.js"
+  },
+  "files": [
+    "bin.js",
+    "LICENSE",
+    "README.md"
+  ],
+  "optionalDependencies": {
+    "herdr-dashr-linux-x64": "0.1.0",
+    "herdr-dashr-linux-arm64": "0.1.0",
+    "herdr-dashr-darwin-x64": "0.1.0",
+    "herdr-dashr-darwin-arm64": "0.1.0"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}