8 releases
new 0.3.0 | Nov 3, 2024 |
---|---|
0.2.2 | Jun 22, 2024 |
0.2.0 | May 24, 2024 |
0.1.1 | May 20, 2024 |
#1787 in Command line utilities
25 downloads per month
7MB
1K
SLoC
flawz is a Terminal User Interface (TUI) for browsing the security vulnerabilities (also known as CVEs).
As default it uses the vulnerability database (NVD) from NIST and provides search and listing functionalities in the terminal with different theming options.
For example, to view details on the notorious xz vulnerability:
flawz --feeds 2024 --query xz
Table of Contents
Installation
Cargo
flawz can be installed from crates.io using cargo
if Rust is installed.
cargo install --locked flawz
The minimum supported Rust version (MSRV) is 1.74.1
.
[!NOTE] You need to have SQLite 3 development files installed. On Debian and its derivates you can do so with the following command:
sudo apt install libsqlite3-dev
Arch Linux
flawz can be installed from the official repositories using pacman
:
pacman -S flawz
Alpine Linux
flawz is available for Alpine Edge. It can be installed via apk
after enabling the testing repository.
apk add flawz
Homebrew
flawz is available for macOS via Homebrew. It can be installed using brew
brew install flawz
Nixpkgs
flawz is available for Nix via nixpkgs-unstable channel. To make it available in the environment, simply run:
nix-channel --add https://nixos.org/channels/nixpkgs-unstable
nix-channel --update nixpkgs
nix-env -iA nixpkgs.flawz
On NixOS:
nix-channel --add https://nixos.org/channels/nixos-unstable
nix-channel --update nixos
nix-env -iA nixos.flawz
Alternatively, if you're using the new experimental CLI, you can use the following:
nix run nixpkgs#flawz
NetBSD
flawz is available from the official repositories. To install it, simply run:
pkgin install flawz
Binary releases
See the available binaries for different targets from the releases page.
Build from source
- Clone the repository.
git clone https://github.com/orhun/flawz && cd flawz/
- Build.
CARGO_TARGET_DIR=target cargo build --release
Binary will be located at target/release/flawz
.
Usage
flawz [OPTIONS]
Options:
--url <URL> A URL where NIST CVE 1.1 feeds can be found [env: URL=] [default:
https://nvd.nist.gov/feeds/json/cve/1.1/]
-f, --feeds [<FEEDS>...] List of feeds that are going to be synced [env: FEEDS=] [default: 2002:2024 recent
modified]
-d, --db <DB> Path to the SQLite database used to store the synced CVE data [env: DB=]
-u, --force-update Always fetch feeds
-o, --offline Do not fetch feeds
-q, --query <QUERY> Start with a search query [env: QUERY=]
-t, --theme <THEME> Set the theme [default: dracula] [possible values: dracula, nord, one-dark, solarized-dark, gruvbox-light]
-h, --help Print help (see more with '--help')
-V, --version Print version
Key bindings
Key | Action | Description |
---|---|---|
k / Up |
Scroll Up | Scroll up the list |
j / Down |
Scroll Down | Scroll down the list |
Enter |
Select | View the selected CVE details |
/ |
Search | Search for a CVE |
Space |
Open | Open the first CVE reference in the browser |
q |
Quit | Set computer on fire |
Examples
To start with a specific search query:
flawz --query "buffer overflow"
You can use the --feeds
option to sync specific years of feeds:
flawz --feeds 2010:2015 recent
Additionally, you can use the following flags:
--force-update
: Always fetch feeds, even if they are already up to date.--offline
: Run without fetching feeds (useful if you have already synced the data):
For example, you can use the following command to search for a specific vulnerability from 2014:
flawz -q "CVE-2014-0160" -f 2014 --force-update
Themes
Start flawz
with --theme
option to set a custom theme, e.g. --theme nord
.
Dracula (default)
Nord
One Dark
Solarized Dark
Gruvbox Light
Support
If you find flawz and/or other projects on my GitHub useful, consider supporting me on GitHub Sponsors! 💖
Contributing
See our Contribution Guide and please follow the Code of Conduct in all your interactions with the project.
License
Licensed under either of Apache License Version 2.0 or The MIT License at your option.
🦀 ノ( º _ º ノ) - respect crables!
Copyright
Copyright © 2024, Orhun Parmaksız
Dependencies
~36–50MB
~861K SLoC