NotAShelf/nix-evaluator-stats
1
0
Fork 0
mirror of https://github.com/NotAShelf/nix-evaluator-stats.git synced 2026-04-27 12:25:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve 'usage instructions' for the web component

Browse source 
Signed-off-by: NotAShelf <raf@notashelf.dev>
Change-Id: Ib70b7d5101bb0e2b103e96770965570f6a6a6964
This commit is contained in:
raf 2026-04-16 09:40:04 +03:00
commit 6484ded3d7
Signed by: NotAShelf
GPG key ID: 29D95B64378DB4BF
1 changed files with 23 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

42
docs/README.md
View file

@ -1,4 +1,4 @@
<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable MD033 MD041 -->
<div align="center">
<h1 id="header">nix-evaluator-stats</h1>
@ -20,21 +20,29 @@
![Demo](./assets/ns-demo.png)
`nix-evaluator-stats`, or "ns" for short, is a pretty visualiser for the Nix
evaluator stats export from `NIX_SHOW_STATS` and `NIX_COUNT_CALLS` invocations.
It takes the resulting JSON data from your Nix invocation with the relevant
variables, and provides a ✨ pretty ✨ dashboard-like visual with the ability to
compare your "snapshots" of benchmarks. Besides looking nice, it is helpful in
`nix-evaluator-stats`, or "`ns`", is a pretty visualiser for the Nix evaluator
stats export from `NIX_SHOW_STATS` and `NIX_COUNT_CALLS` invocations. It takes
the resulting JSON data from your Nix invocation with the relevant variables,
and provides a ✨ pretty ✨ dashboard-like visual with the ability to compare
your "snapshots" of benchmarks. Besides looking nice, it is helpful in
collecting statistics about your Nix commands and tracking performance
regressions in subsequent exports.
regressions in subsequent exports with the comparison feature with snapshot of
your analyses.
## Usage
NS provides both a web application for pretty visuals, and a terminal client (a
TUI) for rendering the statistics from your terminal.
NS is primarily a web application for pretty visuals, with a terminal client
(both a CLI and a TUI) planned for rendering statistics or sharing your analyses
with others.
### Web
<!--markdownlint-disable MD059-->
You can find the site [here](https://notashelf.github.io/nix-evaluator-stats/).
<!--markdownlint-enable MD059-->
Usage instructions are provided in the initial page. Simply navigate to the site
and provide the JSON export (or a file) to render the statistics. The number of
rendered fields might differ based on your Nix version or implementation (Lix,
@ -61,19 +69,15 @@ Once you hit "Load", the JSON will be parsed and you'll be looking at a dash
board of your export. By using the snapshot feature, i.e., saving a particular
analysis you may compare two _named_ analyses at a time.
> [!NOTE]
> `nix-evaluator-stats` was created in a very short duration, and there might be
> UI bugs or areas where UI polish is very clearly missing. Please crate an
> issue if the generated graph or the site UI looks off. Thanks :)
#### Snapshots
Snapshots are an "experimental" (just means they're new and unpolished) feature
that lets you save an analysis in your browser storage with a name to be used
later on in the comparison view. At least two **named** analyses (i.e.,
snapshots) are required for an analysis.
Snapshots are a new feature that lets you save an analysis in your browser
storage with a name to be used later on in the comparison view. At least two
**named** analyses (i.e., snapshots) are required for an analysis.
You can save an analysis as a snapshot from the save button on the bottom right.
You can save can analysis as a snapshot from the save button on the bottom
right. Alternatively, you can visit the "compare" page and paste your JSON
directly.
## Hacking