grm Documentation
Fast, Native Telegram CLI Client Powered by TDLib & C++23.
Welcome to the official documentation portal for grm.
Documentation Architecture
Guide |
Purpose & Scope |
Entrypoint |
|---|---|---|
Business & Strategy |
Strategic vision, ROI goals, and user personas. |
|
Functional Specifications |
Requirements [FUNC-001]..[FUNC-015], behavioral contracts, and interfaces. |
|
Technical Architecture |
Specifications [TECH-001]..[TECH-009], TDLib concurrency, and component architectures. |
|
Architecture Decisions (ADRs) |
Immutable Architecture Decision Records and trade-off analyses. |
|
Project Roadmap |
Sequenced phase milestones, delivery tracking, and verification matrices. |
|
User Manual & Guide |
CLI syntax, options reference, and interactive usage guide. |
Documentation Suite
- Business Specifications
- grm Functional Specification
- Functional Sub-Spec: Authentication & Chat Management
- Functional Sub-Spec: Message CRUD & Export Engine
- Functional Sub-Spec: File & Media Attachment
- Functional Sub-Spec: File Upload & Attachment Download Engine
- Functional Sub-Spec: Supergroup Forum Topics (Threads)
- Functional Sub-Spec: Supergroup Forum Topics CRUD Operations
- Rich Text, Topic Custom Emojis & Branding Spec
- Functional Specification: Chat Folder Management
- [FUNC-014] Universal Cross-Domain Search Functional Specification
- Story & Emoji Status Management Spec
- Functional Specification: CLI Options & Output
- Functional Specification: Subcommand Help & Autocompletion
- Functional Specification: Human & LLM Friendly Output Engine
- Overview
- Core Functional Requirements
- grm Technical Architecture
- Technical Sub-Spec: TDLib Client Architecture & RAII
- Technical Sub-Spec: File Uploader Engine Architecture
- Technical Sub-Spec: Forum Topics Engine Architecture
- Technical Architecture: Chat Folder Management Engine
- [TECH-007] Universal Search Architecture Specification
- Overview
- Architectural Weaknesses Identified
- Technical Refactoring Requirements
- Execution & Verification Protocol
- Unresolved Architectural Items & Future Optimization Roadmap
- Story & Status Subsystem Architecture Spec
- Technical Architecture: Shell Autocompletion
- Technical Architecture: CLI Options & Logging
- Technical Architecture: Formatter & Output Distribution
- Coding Standards
- Threat Model
- [TECH-010] Release Procedure & Versioning Playbook
- Architectural Blueprint
- System Design Principles
- Technical Traceability Matrix
- Architecture Decision Records (ADRs)
- grm Project Roadmap
- Phase 1 Roadmap: Core MVP Engine
- Phase 2 Roadmap: Unit Testing, Modularization & Data Export
- Phase 3 Roadmap: File & Media Attachment Uploads
- Phase 4 Roadmap: Supergroup Forum Topics (Threads)
- Phase 5 Roadmap: Modern Dual Human/AI UX Render Engine (C++23)
- Phase 6 Roadmap: Full CRUD & File Download Engine
- Phase 7: Rich Text, Topic Emojis & Branding Roadmap
- Phase 8 — Automated Release Pipeline & FHS 3.0 Packaging
- Phase 9: Telegram Stories & Emoji Status CLI
- Overview
- Feature Addition Procedure
- Bug Repair Procedure
- Release Procedure & Standard Operating Protocol
- grm Codebase Audits
- Executive Summary
- Phase Breakdown
- GRM - Group & Telegram Manager
- grm