README
¶
CycloneDx Viewer
The main purpose of this project is to teach myself how to build CLI apps in golang.
Beyond that, it might also be useful if you are looking for a small application that can parse a CycloneDx BOM and visualize it.
Right now, this is just a skeleton, but the plan is to support the following features:
- serve a dynamic web page that renders the BOM contents
- write rendered HTML to the local FS for offline consumption
- provide at-a-glance statistics about parsed BOMs on the CLI
Why write it in golang?
- it ships with a small http server that does exactly what I need
- I've worked with hugo before and really like golang's html templating
- I want to learn it and the best way to do so is to build something that might actually be useful to somebody
- It can compile to a single binary that can be distributed standalone
Which itch does this tool attempt to scratch?
Enterprise software is messy, understanding dependency trees that are ten layers deep by looking at a JSON is hard.
So my goal here is to build a small tool that can present the information contained in a Software BOM in a more human-readable manner.
I'm aware that the target audience for that kind of thing isn't huge, but it's a good project to dive a bit deeper into the world of golang.
I am first and foremost trying to solve my own problems here and learn something new along the way, but if, by any means, this little tool is useful to you then you are more than welcome to adopt it.
Documentation
¶
Overview ¶
Copyright © 2021 Alexander Gschrei
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories