@fdekit/console
v0.5.4
Published
Local dashboard renderer for FDEKit traces, evals, governance, and reports
Readme
@fdekit/console
Purpose
@fdekit/console renders the static local dashboard and export bundle for FDEKit traces, evals, macro evals, approvals, audit logs, governance posture, reports, and connector evidence.
Use console when you need dashboard HTML or CSV/Markdown/JSON exports outside the CLI. The CLI uses this package behind fdekit console.
Who should use this package
- CLI contributors working on dashboard output.
- Integrators embedding FDEKit evidence in another local workflow.
- Contributors improving dashboard view models, sections, or export formats.
Choose @fdekit/runtime to read/write artifacts and fdekit to generate the dashboard from the standard command.
Dependency note: React appears in your tree
Installing this package (and therefore @fdekit/cli) pulls react and react-dom.
They come from @pierre/diffs, which renders the annotated code
diffs on the review page. That package declares react and react-dom as required
peer dependencies for the whole package, so npm 7+ installs them automatically.
FDEKit does not use React. The only entrypoint we import is @pierre/diffs/ssr,
which renders diffs to an HTML string server-side (hast → HTML) and imports no React at
all. There is no supported way for an intermediate package to tell npm that a transitive
peer dependency is unused, so the packages are installed even though no FDEKit code path
loads them.
The SSR path also loads @pierre/theming, which imports its optional
@pierre/theme@^1.1.0 peer. Console declares that version directly so clean
installs remain consistent across npm versions; @pierre/diffs keeps its own
incompatible @pierre/[email protected] dependency nested.
Nothing in @fdekit/console or @fdekit/cli executes React at runtime.
5-minute quick example
import { renderConsolePages, createConsoleExportBundle } from '@fdekit/console';
import type { ConsoleData } from '@fdekit/console';
const data: ConsoleData = {
deployment,
traces: [],
latestEval: null,
latestMacroEval: null,
reportMarkdown: null,
approvals: [],
auditLog: [],
};
const pages = renderConsolePages(data);
const exports = createConsoleExportBundle(data);
console.log(pages.map((page) => page.fileName), exports.summaryMarkdown);Public API surface
Import from the package root:
import { renderConsole, renderConsolePages, createConsoleExportBundle } from '@fdekit/console';
import type { ConsoleData, ConsoleExportBundle, ConsoleHistoryEntry, ConsolePage } from '@fdekit/console';The broader public API index documents the console package boundary and import rule: Public API Reference.
Stability/backward-compat notes
@fdekit/console is public but pre-1.0. The root exports renderConsole, renderConsolePages, createConsoleExportBundle, ConsoleData, ConsoleExportBundle, ConsoleHistoryEntry, and ConsolePage.
renderConsole() returns the overview page for compatibility. Use renderConsolePages() when writing the full static dashboard with console.html, charts.html, brief.html, readiness.html, and workbench.html.
Subpath imports are internal. Treat HTML structure and CSS classes as implementation details unless they become documented public hooks.
See also
- Runtime artifacts consumed by the dashboard: @fdekit/runtime
- CLI command that writes
artifacts/console.html: fdekit - Deployment config types used in
ConsoleData: @fdekit/core - Console command docs: CLI Reference
