Skip to content

webscan Documentation#

Hello and welcome to the webscan documentation. While we always want to provide the most comprehensive documentation possible, we thought you may find the below sections a helpful place to get started.

  • The Getting Started section provides onboarding material
  • The Development header is the best place to get started on developing on top of and with webscan
  • See the Docs section for a comprehensive rundown of webscan capabilities

About webscan#

webscan is designed as a simple, easy to use web application scanning tool that security teams can use to automate the collection of data about their web applications. Designed with data-modeling and data-integration needs in mind, webscan can be used on its own as an interactive CLI, orchestrated as part of a broader data pipeline, or leveraged from within the Method Platform.

The types of scans that webscan can conduct are constantly growing. For the most up to date listing, please see the documentation here

To learn more about webscan, please see the Documentation site for the most detailed information.

Quick Start#

Get webscan#

For the full list of available installation options, please see the Installation page. For convenience, here are some of the most commonly used options:

Examples#

webscan discover probe --targets https://example.com --targets https://example.dev

webscan discover page --target https://example.com

Contributing#

Interested in contributing to webscan? Please see our organization wide Contribution page.

Want More?#

If you're looking for an easy way to tie webscan into your broader cybersecurity workflows, or want to leverage some autonomy to improve your overall security posture, you'll love the broader Method Platform.

For more information, visit us here

Community#

webscan is a Method Security open source project.

Learn more about Method's open source source work by checking out our other projects here or our organization wide documentation here.

Have an idea for a Tool to contribute? Open a Discussion here.