core/cli
8
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions 1
cli/pkg/config/docs/architecture.md
Snider 4e02d5bc97 refactor: bring external packages home and restructure 
- Imported packages from separate repos:
  - github.com/Snider/config -> pkg/config
  - github.com/Snider/display -> pkg/display
  - github.com/Snider/help -> pkg/help
  - github.com/Snider/i18n -> pkg/i18n
  - github.com/Snider/updater -> pkg/updater
- Moved core code from root to pkg/core
- Flattened nested package structures
- Updated all import paths to github.com/Snider/Core/pkg/*
- Added Display interface to Core
- Updated go.work for workspace modules

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-15 15:30:43 +00:00

1.9 KiB
Raw Blame History

Architecture Overview

This project implements a modular configuration system with a Go backend and an Angular frontend, orchestrated by a CLI runner.

Components

The architecture consists of three main components:

  1. Backend Library (pkg/config)

    • Responsibility: Manages configuration loading, saving, and persistence.
    • Tech Stack: Go.
    • Features:
      • Struct-based configuration with JSON persistence.
      • Generic key-value storage supporting JSON, YAML, INI, and XML.
      • XDG-compliant directory management.
    • Integration: Can be used via static (New) or dynamic (Register) dependency injection.

  2. Frontend (ui)

    • Responsibility: Provides a user interface for the application.
    • Tech Stack: Angular.
    • Deployment: Built as a static asset (or Custom Element) served by the backend.

  3. CLI Runner (cmd/demo-cli)

    • Responsibility: Entry point for the application.
    • Tech Stack: Go (spf13/cobra).
    • Functions:
      • serve: Starts a web server that hosts the compiled Angular frontend and API endpoints.

Data Flow

  1. Initialization: The CLI starts and initializes the pkg/config service to load settings from disk.
  2. Serving: The CLI's serve command spins up an HTTP server.
  3. Interaction: Users interact with the Angular UI in the browser.
  4. API Communication: The UI communicates with the backend via REST API endpoints (e.g., /api/v1/demo).
  5. Persistence: Configuration changes made via the backend service are persisted to the filesystem.

Directory Structure

├── cmd/
│   └── demo-cli/       # CLI Application entry point
├── pkg/
│   └── config/         # Core configuration logic (Go)
├── ui/                 # Frontend application (Angular)
└── docs/               # Project documentation