Skip to content

Commit 9cc89d0

Browse files
committed
docs(snapshot/README): Add Capabilities and Limitations table
why: Clarify module boundaries and set appropriate user expectations what: - Added a clear tabular format separating what the module can and cannot do - Highlighted key capabilities with checkmarks - Identified important limitations with X marks
1 parent f1b04bb commit 9cc89d0

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/libtmux/snapshot/README.md

+13
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,19 @@ Snapshots provide several key benefits for tmux automation and management:
2323
- **Filtering & Searching:** Find specific components within complex tmux arrangements
2424
- **Dictionary Conversion:** Serialize tmux state for storage or analysis
2525

26+
## Capabilities and Limitations
27+
28+
| What It IS | What It IS NOT |
29+
|------------|----------------|
30+
|**Structure Preserver**: Captures hierarchical tmux objects (servers, sessions, windows, panes) |**Memory Snapshot**: Doesn't capture system memory state or processes beyond tmux |
31+
|**Immutable Reference**: Creates read-only records that won't change as live tmux changes |**Time Machine**: Can't revert the actual tmux server to previous states |
32+
|**Content Capturer**: Preserves visible pane text content when requested |**State Restorer**: Doesn't automatically recreate previous environments |
33+
|**Relationship Keeper**: Maintains parent-child relationships between tmux objects |**App State Preserver**: Can't capture internal application state (e.g., vim buffers/cursor) |
34+
|**Filtering Tool**: Provides ways to search objects based on custom criteria |**Server Modifier**: Doesn't change the live tmux server in any way |
35+
|**Serialization Mechanism**: Converts tmux state to dictionaries for storage |**Process Manager**: Doesn't track processes beyond their visible output |
36+
|**Testing Aid**: Enables tmux automation tests with before/after comparisons |**Complete Backup**: Doesn't capture scrollback buffers or hidden app state |
37+
|**Configuration Recorder**: Documents session layouts for reference |**System Restorer**: Can't restore the full system to a previous point in time |
38+
2639
## Installation
2740

2841
The snapshot module is included with libtmux:

0 commit comments

Comments
 (0)