cargo-firstpage 0.2.3

Shows only the first page of rustc output
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

[![Latest Version](https://img.shields.io/crates/v/cargo-firstpage.svg)](https://crates.io/crates/cargo-firstpage)
![License](https://img.shields.io/crates/l/cargo-firstpage)
[![LOC](https://tokei.rs/b1/github/cecton/cargo-firstpage)](https://github.com/cecton/cargo-firstpage)
[![Dependency Status](https://deps.rs/repo/github/cecton/cargo-firstpage/status.svg)](https://deps.rs/repo/github/cecton/cargo-firstpage)

# cargo-firstpage

Show only the first page of `rustc` output.

## Installation

```bash
cargo install cargo-firstpage
```

## Usage

Add `firstpage` before any `cargo` command:

### Examples

This runs `cargo check` but only shows the first page of output:

```bash
cargo firstpage check
```

This runs `cargo run -p myproject`:

```bash
cargo firstpage run -p myproject
```

All arguments after `firstpage` are passed directly to `cargo` without
exception. `cargo-firstpage` does not have any option is and not
parametrizable.

### Using with `cargo-watch`

You can use it like this:

```bash
cargo watch -x "firstpage check"
```

If you want to see just the first page of the build output while keeping your
program’s error messages:

```bash
cargo watch -x "firstpage build" -x "run"
```

For TUI (text user interface) programs, use this in one terminal:

```bash
CARGO_TERM_COLOR=always cargo watch \
    -x "firstpage build 2>/tmp/logs" \
    -x "run 2>>/tmp/logs"
```

And this in another terminal:

```bash
tail -F /tmp/logs
```

This setup keeps your program's stderr output scrolling while only showing the
first page of build messages.

## Troubleshooting

If your shell prompt takes up more than one line, `cargo-firstpage` might
miscalculate how much space is available for output. To fix this, you can set
the `PROMPT_SIZE` compilation parameter when installing the tool.

### Example

If your prompt is 2 lines high:

```bash
PROMPT_SIZE=2 cargo install cargo-firstpage --force
```

Adjust the value of `PROMPT_SIZE` to match the number of lines your prompt
uses.

## Limitations

In most cases, the useful error messages appear at the end of the output.
However, sometimes `rustc` shows important information at the beginning, like
how to disable a warning.

## Contributing

This project does not accept issues, pull requests, or other contributions.
Forks are welcome — feel free to use, modify, and build on it as needed.

## Related Tools

- [ograc](https://gitlab.com/lirnril/ograc): Shows diagnostic messages in
  reverse order, so important ones appear first. You can scroll up to see less
  important ones.
- [cargo-cut-diagnostics](https://github.com/SabrinaJewson/cargo-cut-diagnostics):
  Similar to `cargo-firstpage`, but keeps the progress bar and offers more
  options. The author claims it processes cargo output more accurately. Try
  this if you have issues with `cargo-firstpage`.
- [bacon](https://github.com/Canop/bacon): Combines features of `cargo-watch`
  with a small TUI that makes it easier to filter and read logs. Worth checking
  out if you want to improve the readability and scrolling of `rustc` output.