CLI_Interface.md

graph LR
    CLI_Orchestrator["CLI Orchestrator"]
    Initialization_Handler["Initialization Handler"]
    Query_Processor["Query Processor"]
    Policy_Generator["Policy Generator"]
    CLI_Orchestrator -- "dispatches commands to" --> Initialization_Handler
    CLI_Orchestrator -- "dispatches commands to" --> Query_Processor
    CLI_Orchestrator -- "dispatches commands to" --> Policy_Generator

Loading

Details

This subsystem is the user-facing entry point of policy_sentry, responsible for interpreting user commands and orchestrating the execution of core functionalities. It ensures that user input is correctly parsed, validated, and directed to the appropriate backend processing modules.

CLI Orchestrator

The primary component responsible for parsing command-line arguments, validating user input, and dispatching the execution flow to the appropriate backend command modules. It acts as the central entry point and orchestrator for all user-initiated operations within the policy_sentry CLI tool.

Related Classes/Methods:

• policy_sentry.bin.cli

Initialization Handler

Handles the logic for initializing the local database, including schema creation and initial data population. It is invoked by the CLI Orchestrator when the user requests database setup.

Related Classes/Methods:

• policy_sentry.command.initialize

Query Processor

Manages the execution of queries against the IAM data store. It processes user-defined query parameters and retrieves relevant AWS IAM data, such as actions, services, or ARNs.

Related Classes/Methods:

• policy_sentry.command.query

Policy Generator

Responsible for constructing and writing AWS IAM policies based on user specifications. It takes input parameters (e.g., actions, ARNs) and generates a valid IAM policy document, often in YAML or JSON format.

Related Classes/Methods:

• policy_sentry.command.write_policy

FAQ