# solacelabs/solace-tryme-cli architecture

> Architecture diagram of the GitHub repository solacelabs/solace-tryme-cli, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-13). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/solacelabs/solace-tryme-cli
- Repository: https://github.com/solacelabs/solace-tryme-cli

## Overview

##### Project type and purpose
- This is a full-feature Node.js/TypeScript CLI tool for messaging and streaming operations on a Solace PubSub+ Broker.
- It supports standard messaging commands (send, receive, request, reply), resource management (queues, profiles via SEMP), and an AsyncAPI-driven event-feed generator that uses Faker.js for mock data.

##### File structure
- Top-level:
– bin/index.js: CLI bootstrap (shebang to load compiled src/index.js).
– src/: all TypeScript source.
- src/index.ts: entrypoint – sets up Commander.js and loads commands.
- src/common/: low-level client wrappers (publish, receive, queue-client, etc.).
- src/lib/: command implementations (feed-generate, feed-run, manage-*, messaging commands).
- src/utils/: helpers (config loader, logger, AsyncAPI parser, Faker integration, CLI event handlers).
- src/types/: TypeScript definitions.
– public/: static website UI for “Feed Portal” (HTML/JS using MQTTSolaceClient.js, Paho, etc.).
– documentation/: Markdown guides.
– scripts/: install/update helper scripts.
– sample-config/: example JSON configuration.

##### README for additional insights
- Uses Commander.js for CLI parsing.
- Two external interfaces:
– Messaging API: WebSocket connection to broker for pub/sub.
– Management API: HTTP(S) SEMPv2 REST calls for resource CRUD.
- Feed functionality:
– Input: AsyncAPI document.
– Processing: AsyncAPI parser + Faker.js + user-defined data rules.
– Output: outbound events to broker.

##### Main components
A. CLI Application
– Commander.js Command Parser
– Config Manager (loads/stores ~/.stm config)
– Command Modules (send, receive, request, reply, config, manage, feed)
B. Core Libraries
– Messaging Client (PubSub+ JavaScript API over WebSocket)
– Management Client (HTTP client to SEMPv2 REST)
– AsyncAPI Parser & Data Generator (Faker.js + feed-datarules)
– Common Clients (queue-client, publish-client, etc.)
C. File System
– AsyncAPI Documents (user-provided)
– Configuration Files (~/.stm JSON)
– Feed definition files (import/export)
D. External Services
– Solace PubSub+ Broker (WebSocket messaging endpoint)
– Solace PubSub+ Broker SEMPv2 API (HTTP REST)
E. Static Feed Portal UI (optional)
– Hosted static files (public/*.html, JS libs)
– In-browser MQTT/WebSocket client (Paho, MQTTSolaceClient.js)

##### Relationships & interactions
- CLI → Config Manager: read/write command settings
- CLI → Command Module → Core Library
– Messaging commands → Messaging Client → WebSocket → Broker
– Manage commands → Management Client → HTTP REST → Broker SEMP API
– Feed commands:
- preview/generate → AsyncAPI Parser + Faker.js → local files
- run → uses Messaging Client to stream events
- Static UI → In-browser MQTTSolaceClient.js → WebSocket → Broker

##### Architectural patterns & design principles
- Modular CLI: separate Command Parser, Core Libraries, and low-level clients
- Dependency injection via utils/config → each client gets connection params
- Reusable common clients for messaging & management
- Feed pipeline: parse → transform (Faker rules) → output (publish)
- Clear separation: CLI logic vs. business logic vs. transport layer

- Node.js & TypeScript
- Commander.js (CLI parsing)
- PubSub+ JavaScript API (WebSocket messaging)
- Axios or built-in HTTP client for SEMPv2
- AsyncAPI Parser + Faker.js (data generation)
- Static UI libs: Paho-MQTT.js, Bootstrap, jQuery

##### Don’t overthink—capture all modules as components
- Bin (CLI bootstrap)
- Config Manager
- Commander.js parser
- Each command group (Messaging, Manage, Feed)
- Common clients sub-components
- Utils (logger, chalk, parse)
- External endpoints

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Local CLI Layer
    subgraph "Local CLI"
        CLI_Bin["CLI Bootstrap"]:::cli
        CLI_Entrypoint["Entrypoint & Parser (Commander.js)"]:::cli
        Config["Config Manager"]:::cli
        Logger["Logger Utility"]:::cli
        Control["CLI Event Handlers"]:::cli
        Parse["Parser Utils"]:::cli
        Options["Options Utils"]:::cli
        subgraph "Command Modules"
            Cmd_Messaging["Messaging Commands"]:::cli
            Cmd_Management["Resource Management Commands"]:::cli
            Cmd_Feed["Feed Commands"]:::cli
        end
    end

    %% Core Libraries Layer
    subgraph "Core Libraries"
        %% Messaging Clients
        PublishClient["Publish Client"]:::core
        ReceiveClient["Receive Client"]:::core
        RequestClient["Request Client"]:::core
        ReplyClient["Reply Client"]:::core
        QueueClient["Queue Client"]:::core
        FeedPublishClient["Feed Publish Client"]:::core
        VisualizeClient["Visualize Client"]:::core

        %% Management Clients
        ACLProfileClient["ACL Profile Client"]:::core
        ClientProfileClient["Client Profile Client"]:::core
        ClientUsernameClient["Client Username Client"]:::core
        SEMPConnectionHelper["SEMP Connection Helper"]:::core

        %% AsyncAPI & Data Generation
        JSONParser["AsyncAPI JSON Parser"]:::core
        FakerRules["Faker.js Rules Integration"]:::core
        FeedDatarules["Feed Data Rules"]:::core
    end

    %% File System Layer
    subgraph "File System"
        AsyncAPI["AsyncAPI Documents"]:::storage
        ConfigFile["Config File (~/.stm)"]:::storage
        FeedDefs["Feed Definition Files"]:::storage
        SampleConfig["Sample Config File"]:::storage
    end

    %% External Services Layer
    subgraph "External Services"
        BrokerMsg["Broker Messaging Endpoint"]:::external
        BrokerSEMP["Broker SEMPv2 REST API"]:::external
    end

    %% Static UI Layer
    subgraph "Static Feed Portal UI"
        HTMLFiles["HTML Entry Points"]:::ui
        JSlibs["JavaScript Libraries"]:::ui
        Assets["Feed Portal Assets & Forms"]:::ui
        Styles["Styles & Plugins"]:::ui
    end

    %% Connections: CLI flow
    CLI_Bin -->|"loads"| CLI_Entrypoint
    CLI_Entrypoint -->|"reads/writes"| Config
    CLI_Entrypoint -->|"logs via"| Logger
    CLI_Entrypoint -->|"handles events"| Control
    CLI_Entrypoint -->|"parses args"| Parse
    CLI_Entrypoint -->|"options"| Options
    CLI_Entrypoint -->|"dispatches to"| Cmd_Messaging
    CLI_Entrypoint -->|"dispatches to"| Cmd_Management
    CLI_Entrypoint -->|"dispatches to"| Cmd_Feed

    %% Command modules to core libraries
    Cmd_Messaging -->|"use clients"| PublishClient
    Cmd_Messaging --> ReceiveClient
    Cmd_Messaging --> RequestClient
    Cmd_Messaging --> ReplyClient
    Cmd_Messaging --> QueueClient

    Cmd_Management -->|"use SEMP REST"| ACLProfileClient
    Cmd_Management --> ClientProfileClient
    Cmd_Management --> ClientUsernameClient
    Cmd_Management --> SEMPConnectionHelper

    Cmd_Feed -->|"parse feed"| JSONParser
    Cmd_Feed --> FakerRules
    Cmd_Feed --> FeedDatarules
    Cmd_Feed --> FeedPublishClient

    %% Core to external
    PublishClient -->|-->| BrokerMsg
    ReceiveClient -->|<--| BrokerMsg
    RequestClient -->|-->| BrokerMsg
    ReplyClient -->|<--| BrokerMsg
    QueueClient -->|-->| BrokerMsg

    FeedPublishClient -->|-->| BrokerMsg

    ACLProfileClient -->|-->| BrokerSEMP
    ClientProfileClient -->|-->| BrokerSEMP
    ClientUsernameClient -->|-->| BrokerSEMP
    SEMPConnectionHelper -->|-->| BrokerSEMP

    %% File system interactions
    Cmd_Feed -->|"reads"| AsyncAPI
    Cmd_Feed -->|"writes"| FeedDefs
    Config -->|"loads/stores"| ConfigFile

    %% Static UI to broker
    HTMLFiles -->|MQTT over WebSocket| BrokerMsg
    JSlibs -->|MQTT over WebSocket| BrokerMsg

    %% Sample config file
    SampleConfig

    %% Click Events
    click CLI_Bin "https://github.com/solacelabs/solace-tryme-cli/blob/main/bin/index.js"
    click CLI_Entrypoint "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/index.ts"
    click Config "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/utils/config.ts"
    click Logger "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/utils/logger.ts"
    click Control "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/utils/controlevents.ts"
    click Parse "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/utils/parse.ts"
    click Options "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/utils/options.ts"
    click PublishClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/publish-client.ts"
    click ReceiveClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/receive-client.ts"
    click RequestClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/request-client.ts"
    click ReplyClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/reply-client.ts"
    click QueueClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/queue-client.ts"
    click FeedPublishClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/feed-publish-client.ts"
    click VisualizeClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/visualize-client.ts"
    click ACLProfileClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/aclprofile-client.ts"
    click ClientProfileClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/clientprofile-client.ts"
    click ClientUsernameClient "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/clientusername-client.ts"
    click SEMPConnectionHelper "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/lib/semp-connection.ts"
    click JSONParser "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/common/jsonParser.ts"
    click FakerRules "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/utils/fakerrules.ts"
    click FeedDatarules "https://github.com/solacelabs/solace-tryme-cli/blob/main/src/lib/feed-datarules.ts"
    click SampleConfig "https://github.com/solacelabs/solace-tryme-cli/blob/main/sample-config/stm-cli-config.json"
    click HTMLFiles "https://github.com/solacelabs/solace-tryme-cli/blob/main/public/feed.html"
    click JSlibs "https://github.com/solacelabs/solace-tryme-cli/blob/main/public/scripts/MQTTSolaceClient.js"
    click Assets "https://github.com/solacelabs/solace-tryme-cli/tree/main/public/feedportal/"
    click Styles "https://github.com/solacelabs/solace-tryme-cli/tree/main/public/styles/"

    %% Styles
    classDef cli fill:#D0E6FF,stroke:#0066CC,color:#000;
    classDef core fill:#D5F5E3,stroke:#229954,color:#000;
    classDef external fill:#FAD7A0,stroke:#CA6F1E,color:#000;
    classDef ui fill:#E8DAEF,stroke:#8E44AD,color:#000;
    classDef storage fill:#F2F3F4,stroke:#6C7A89,color:#000;
```
