Overview

Nightfall Radar allows you to scan the entire commit history of any repo you have access to. You can scan a single GitHub repository by entering its URL, or set up a Workflow to scan your entire GitHub organization. This article will cover how to scan an individual repo by URL.

To learn more about scanning all repos in an organization, please visit the Workflows help article here.

Initiating a scan

To start scanning an individual repo, simply enter its URL in the upper-right corner of the dashboard and click ‘Scan Repo’. Details on the results will not be available until the scan has been completed.

Once a scan has been initiated, a green text box will appear to confirm the start of the scan, along with a new entry listing the scan date/time, repo URL, status (Running), and current number of results found thus far.

Once a scan is complete and the page is refreshed, the ‘Status’ should say ‘Completed’ and will include the amount of time the scan took to finish. The ‘Results’ button will now be clickable to view your scan data.

View Your Scan Results

Upon clicking ‘Results’ for a specific scan, you will be taken to a new page where you can find high-level information and detailed findings. You can export these results to a CSV file on your local machine by clicking the "Export CSV" button in the upper-righthand corner.

Clicking 'Details' next to a particular finding will display additional information about the results (as seen below):

Clicking 'GitHub' next to a finding will navigate you to the specific page in your GitHub repository where your result was found.

Conclusion

With the information available in these scan results, you are now equipped to dive into the sensitive areas of your GitHub organization. To follow the steps required to scan all of your organization's repositories, click here. To learn how to view all historical scan results, please visit the dashboard introduction page here.

If you have any additional questions, do not hesitate to email support@nightfall.ai.

Did this answer your question?