|
1 | | -# fossa-rendergraph |
| 1 | +# rendergraph |
2 | 2 |
|
3 | 3 | Utility to render the output of `fossa analyze -o` as a graph. |
4 | 4 |
|
5 | 5 | This program isn't _guaranteed_ to not be broken by new FOSSA CLI releases, |
6 | 6 | but we'll try to keep it from doing so especially since we try to keep output of FOSSA CLI stable. |
7 | 7 |
|
8 | | -# Installation from source |
9 | | - |
10 | | -0. Install `rust`: https://www.rust-lang.org/tools/install |
11 | | -1. Clone this repo locally |
12 | | -2. Run `cargo install --path rendergraph` from the parent directory. |
13 | | -3. Use as `fossa analyze -o | rendergraph` (you can also `cat output.json | rendergraph`- any stdin works) |
| 8 | +`rendergraph` is unlikely to get additional features; we'll almost definitely roll this into other tooling |
| 9 | +such as FOSSA CLI or `ficus` itself if we choose to make changes to how this works. |
14 | 10 |
|
15 | 11 | # What to expect |
16 | 12 |
|
|
28 | 24 |
|
29 | 25 | This tool outputs all dependencies found by FOSSA and doesn't currently account for FOSSA's "unused dependencies" graph pruning. |
30 | 26 |
|
31 | | -# Future work |
32 | | - |
33 | | -A list of things I've thought of to add. Have an idea? Add it to this list via PR! |
34 | | - |
35 | | -- [ ] Account for graph pruning (use source units to do this) |
36 | | -- [ ] Support graphviz output |
37 | | - |
38 | 27 | # Example output |
39 | 28 |
|
40 | 29 | Note: This output was truncated for readability. |
@@ -226,3 +215,13 @@ github.com/fossas/fossa-cli@v1.1.10 |
226 | 215 | ├─ github.com/Masterminds/semver@v1.5.0 |
227 | 216 | └─ github.com/BurntSushi/toml@v0.3.1 |
228 | 217 | ``` |
| 218 | + |
| 219 | +# Installation from source |
| 220 | + |
| 221 | +You should be able to manually download `rendergraph` from the FOSSA CLI github releases. |
| 222 | +However if you have to or want to build manually: |
| 223 | + |
| 224 | +0. Install `rust`: https://www.rust-lang.org/tools/install |
| 225 | +1. Clone this repo locally |
| 226 | +2. Run `cargo install --path rendergraph` from the parent directory. |
| 227 | +3. Use as `fossa analyze -o | rendergraph` (you can also `cat output.json | rendergraph`- any stdin works) |
0 commit comments