Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maralorn committed Mar 4, 2021
1 parent 22a074e commit 2ce2612
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
nix-output-monitor
==================
# nix-output-monitor

Pipe your nix-build output through the nix-output-monitor (aka nom) to get additional information while building.

[![Packaging status](https://repology.org/badge/vertical-allrepos/nix-output-monitor.svg)](https://repology.org/project/nix-output-monitor/versions)

## Status

This is an experimental fun project. The purpose of it is to write something fun and useful in Haskell. You are free and very welcome to contribute feedback, issues or PRs, but I do not commit to maintain this project over a long time period.
Expand All @@ -18,6 +19,12 @@ Best case scenario: This could serve as inspiration as to how to improve nix out

## Running

### The Easy Way

When installed from nixpkgs you can replace every call to `nix-build` with the bundled wrapper script `nom-build`.

### The Flexible Way

Once you have installed `nix-output-monitor` to your path, run any nix command (`nixos-rebuild`,`nix-build`,`home-manager switch`, **not** `nix build`.) and pipe stderr and stdout into `nom`.

```shell
Expand All @@ -26,9 +33,9 @@ nix-build |& nom

**Don‘t forget to redirect stderr, too.** That's what the `&`, does.

### Preserving colored text
### Preserving Colored Text

To preserve the color of the redirected text you can use the `unbuffer` command from the `expect` package.
To preserve the color of the redirected text you can use the `unbuffer` command from the `expect` package. (The `nom-build` wrapper does this for you.)

```shell
unbuffer nix-build |& nom
Expand Down

0 comments on commit 2ce2612

Please sign in to comment.