Skip to content

Latest commit

 

History

History
14 lines (10 loc) · 733 Bytes

ARCHITECTURE.md

File metadata and controls

14 lines (10 loc) · 733 Bytes

Architecture

This document aims to answer the question Where is the code that does X?

Project Layout

The directory structure is broken down as follows:

  • cmd/ - These CLI tools are primarily used during development for end-to-end testing without needing to pull the library into tunnel/tfsec etc.
  • rules - All of the rules and policies are defined in this directory.
  • pkg/spec - Logic to handle standardized specs such as CIS.
  • pkg/rules - This package exposes internal rules, and imports them accordingly (see rules.go).
  • test - Integration tests and other high-level tests that require a full build of the project.
  • scripts - Usefule generation scripts for bundle generation and verification purposes.