Vuls

Vuls

  • Docs
  • Community
  • Blog
  • Languages iconEnglish
    • 日本語
  • GitHub
  • vulsdoc

›Installation

Introduction

  • Abstract
  • Main Features
  • Supported OS

Architecture

  • Remote, Local, One-liner scan
  • Remote Scan Mode
  • One-liner scan mode
  • Local Scan Mode
  • architecture
  • Fast Scan
  • Fast-Root Scan
  • Deep Scan
  • CPE Scan

Installation

  • Vulsctl - Quickest Vuls setup
  • Vulsctl - Install on HostOS
  • Install Manually
  • Install with Docker
  • Install with Package
  • Install with Ansible
  • Install with awless

Tutorial

  • Tutorial
  • Scan with Vulsctl
  • Local Scan Mode
  • Remote Scan Mode
  • Scan using Docker
  • Scan Docker Image
  • Scan non OS packages
  • Scan WordPress
  • Scan Port
  • Scan Windows

Usage

  • config.toml
  • Automatic Discovery
  • configtest
  • Scan
  • Report
  • TUI
  • Server

Vulsrepo

  • VulsRepo

Development

  • Contribute
  • Integration Testing

Misc

  • Cron
  • Update Vuls to the latest version
  • go-cve-dictionary
  • goval-dictionary
  • gost
  • go-exploitdb
  • go-msfdb
  • go-kev
  • go-cti
  • Related Projects
  • Tips
Edit

Install with vulsctl on host

Vulsctl

Vulsctl was created to ease setup.

Deploy vuls on the host

You can deploy vuls on your host easily while using the install.sh script. To know what the script doing, it's quicker to look at the script.

install

$ sudo bash install.sh

Fetch all databases

Fetch the vulnerability databases used by Vuls to the current directory using update-all.sh. Fetching all databases is time consuming. Look at the script before executing update-all.sh and make sure you fetch only what you need.

$ update-all.sh

Update Modules

Update Vuls-related modules to the latest version using upgrade.sh.

$ sudo bash upgrade.sh

Scan and Report

You can find the Vuls command in /usr/local/bin/vuls, and the config.toml sample is here. If you don't define the SQLite3 databases path in config.toml, Vuls uses the ones in the same directory as the Vuls binaries. Scanning and reporting command is the following.

$ which vuls
/usr/loca/bin/vuls
$ ls config.toml
config.toml
$ ls *.sqlite3
oval.sqlite3 go-cti.sqlite3 go-exploitdb.sqlite3 go-kev.sqlite3 go-msfdb.sqlite3 gost.sqlite3 cve.sqlite3
$ vuls scan
$ vuls report
$ vuls tui
← Vulsctl - Quickest Vuls setupInstall Manually →
Vuls
Docs
IntroductionArchitectureTutorial
Community
Join SlackSlackTwitter(English)Twitter(Japanese)
More
BlogGitHub
Copyright © 2025 kotakanbe