# flanliulf/ai-copyright-application-generator architecture

> Architecture diagram of the GitHub repository flanliulf/ai-copyright-application-generator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/flanliulf/ai-copyright-application-generator
- Repository: https://github.com/flanliulf/ai-copyright-application-generator

## Overview

##### Project Type and Purpose
- This is an open-source, CLI-driven tool (Python & Shell scripts) that automates the generation of software copyright application materials.
- It reads user-provided requirements and configuration, applies AI-driven prompts and local merge utilities, and outputs all the documents and source code needed for a software-copyright application.

##### File-Structure Analysis & Architectural Patterns
- Top-level “scripts/” folder subdivided into three main modules:
a. init (project scaffolding)
b. generators (AI-prompt code/doc generation + merging)
c. validators (project integrity & quality checks)
- “requires_docs/” holds user inputs; “specs_docs/” & “system_prompts/” hold templates and AI prompt definitions.
- “process_docs/” is an intermediate staging area; “output_docs/” and “output_sourcecode/” are final material artifacts.
- Config files: ai-copyright-config.json drives customization (UI style, tech stack, page count).
- CLI entrypoints (“create-copyright-project”, main python scripts) orchestrate the workflow.
- No persistent database—file system is the primary data store.
- Pattern: modular pipeline (Init → Generate → Validate), with pluggable template/prompt repositories and an external AI-service integration.

##### Key Components to Plot
1. User / CLI Layer
- CLI Wrapper (Python / Shell entrypoints)
- create-copyright-project command
2. Configuration & Templates
- Config Manager (reads ai-copyright-config.json)
- Templates Repository
- system_prompts/
- specs_docs/
3. Workflow Modules
- Init Module
- scripts/init/ → scaffolds new project directories & config
- Generator Module
- scripts/generators/
- Sub-components: AI Prompt Engine, Local Merge Engine
- Validator Module
- scripts/validators/
4. External Services
- AI Service (cloud or local LLM API)
5. Data Stores (File System)
- Input: requires_docs/
- Intermediate: process_docs/
- Output: output_docs/, output_sourcecode/

##### Interactions & Data Flow
1. User invokes CLI command → CLI Wrapper
2. CLI Wrapper → Init Module → reads config template → writes scaffold (requires_docs/, config JSON)
3. User populates requires_docs/ (requirements.md, optional UI spec, tech-stack spec)
4. CLI Wrapper → Generator Module
a. Reads requires_docs/ + config
b. Loads corresponding AI prompt templates (system_prompts/)
c. Sends prompts + variables to AI Service → receives generated docs/code fragments
d. Local Merge Engine stitches fragments → process_docs/ → final output directories
5. CLI Wrapper → Validator Module
a. Reads both input & outputs → runs consistency, style, completeness checks
b. Reports status & suggests fixes
6. Outputs (complete docs, source code) written to output_docs/ & output_sourcecode/

##### Important Architectural Patterns & Principles
- Pipeline architecture (Init → Generate → Validate) for clear separation of concerns.
- Template-driven code generation: all AI prompts and UI/tech-stack specs abstracted into file repositories.
- Configuration-first design: ai-copyright-config.json controls module behavior.
- Extensibility: new UI styles or prompt categories can be added by dropping files into specs_docs/ or system_prompts/.
- File-system as single source of truth—no external database.

##### Summary
- Surround it with the configuration layer above, file stores on the left (input) and right (output), and external AI service on top right.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Interaction & CLI Layer
    subgraph "User Interaction & CLI"
        direction TB
        User["User"]:::external
        CLIWrapper["CLI Wrapper"]:::cli
        ShellCLI["Shell CLI Entrypoint"]:::cli
        CreateCommand["create-copyright-project"]:::cli
    end

    User -->|"invokes"| CLIWrapper
    CLIWrapper -->|"calls"| ShellCLI
    CLIWrapper -->|"executes"| CreateCommand

    click CLIWrapper "https://github.com/flanliulf/ai-copyright-application-generator/blob/main/ai-copyright.py"
    click ShellCLI "https://github.com/flanliulf/ai-copyright-application-generator/blob/main/ai-copyright.sh"

    %% Configuration & Templates
    subgraph "Configuration & Templates"
        direction TB
        ConfigManager["Config Manager"]:::config
        ConfigExample["Config Template Example"]:::config
        SpecsDocs["UI & Tech-Stack Specs\n(specs_docs/)"]:::store
        Prompts["AI Prompt Definitions\n(system_prompts/)"]:::store
    end

    CLIWrapper -->|"reads config"| ConfigManager
    ConfigManager -->|"loads example"| ConfigExample
    CLIWrapper -->|"loads templates"| SpecsDocs
    CLIWrapper -->|"loads prompts"| Prompts

    click ConfigManager "https://github.com/flanliulf/ai-copyright-application-generator/blob/main/ai-copyright-config.json"
    click ConfigExample "https://github.com/flanliulf/ai-copyright-application-generator/blob/main/config/ai-copyright-config.example.json"
    click SpecsDocs "https://github.com/flanliulf/ai-copyright-application-generator/tree/main/specs_docs/"
    click Prompts "https://github.com/flanliulf/ai-copyright-application-generator/tree/main/system_prompts/"

    %% Core Pipeline
    subgraph "Core Pipeline" 
        direction TB
        InitModule["Init Module"]:::module
        subgraph "Generator Module"
            direction TB
            AIPrompt["AI Prompt Engine"]:::module
            LocalMerge["Local Merge Engine"]:::module
        end
        Validator["Validator Module"]:::module
    end

    CLIWrapper -->|"init"| InitModule
    InitModule -->|"writes scaffold"| Requires["requires_docs/"]:::store
    CLIWrapper -->|"generate"| AIPrompt
    AIPrompt -->|"sends prompts"| AIService
    AIPrompt -->|"outputs fragments"| LocalMerge
    LocalMerge -->|"stages docs"| Process["process_docs/"]:::store
    CLIWrapper -->|"validate"| Validator
    Validator -->|"reads inputs"| Requires
    Validator -->|"reads outputs"| Process
    Validator -->|"writes final docs"| OutputDocs["output_docs/"]:::store
    Validator -->|"writes sourcecode"| OutputCode["output_sourcecode/"]:::store

    click InitModule "https://github.com/flanliulf/ai-copyright-application-generator/blob/main/scripts/init/init_project.py"
    click AIPrompt "https://github.com/flanliulf/ai-copyright-application-generator/blob/main/scripts/generators/generate_all_sourcecode.py"
    click LocalMerge "https://github.com/flanliulf/ai-copyright-application-generator/blob/main/scripts/generators/merge_all_simple.py"
    click Validator "https://github.com/flanliulf/ai-copyright-application-generator/blob/main/scripts/validators/check_project.py"
    click Requires "https://github.com/flanliulf/ai-copyright-application-generator/tree/main/requires_docs/"

    %% External Services
    AIService["AI Service (LLM API)"]:::external
    AIPrompt --> AIService

    %% File System Artifacts
    classDef external fill:#FFDD99,stroke:#E69500,color:#000
    classDef cli fill:#CCE5FF,stroke:#3399FF,color:#000
    classDef config fill:#E6E6E6,stroke:#999, color:#000
    classDef store fill:#F2F2F2,stroke:#666, color:#000
    classDef module fill:#CCFFCC,stroke:#33CC33, color:#000
```
