Skip to content

Commit 9f7693c

Browse files
authored
update
1 parent fcc8915 commit 9f7693c

1 file changed

Lines changed: 15 additions & 13 deletions

File tree

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ A terminal user interface (TUI) for Effect DevTools. View traces, spans, metrics
55
Built with [OpenTUI](https://github.com/opentui/opentui) and inspired by the [Effect DevTools VS Code extension](../vscode-extension/), but with a more limited feature set focused on observability rather than debugging.
66

77
<img width="1056" height="864" alt="20251210" src="https://github.com/user-attachments/assets/acc54df6-77fa-4b5c-b189-6ccba2e0bd14" />
8+
<img width="957" height="420" alt="Screenshot_20251212_210250" src="https://github.com/user-attachments/assets/cbc0fe98-b27f-4cf1-bbb9-f677cfedb827" />
89

910
## Installation
1011

@@ -18,9 +19,21 @@ npmx effect-devtui
1819

1920
## Features
2021

22+
### Observability
23+
2124
- 🔍 **Real-time Span Viewer** - View and navigate span traces with expandable tree structure
2225
- 📊 **Metrics Dashboard** - Monitor counters, gauges, histograms, frequencies, and summaries
2326
- 👥 **Multi-Client Support** - Connect multiple Effect applications simultaneously
27+
28+
### Code Analysis & Fixing
29+
30+
- 🔧 **Automatic Layer Fixer** - Detect missing Effect service requirements and auto-generate layer composition code
31+
- 🎯 **Layer Analysis** - Scan codebase for Layer definitions and resolve service dependencies
32+
- 📋 **Dependency Resolution** - Handle transitive dependencies and multiple layer candidates
33+
-**Code Generation** - Auto-apply fixes directly to source files with AST-aware transformations
34+
35+
### General
36+
2437
- ⌨️ **Keyboard Navigation** - Vim-style navigation (j/k) with intuitive shortcuts
2538
- 🎨 **Split Panel Layout** - Side-by-side view of data and detailed information
2639
- 🚀 **Lightweight** - Runs in any terminal, no GUI required
@@ -47,10 +60,7 @@ const program = Effect.log("Hello!").pipe(
4760
Effect.forever,
4861
);
4962

50-
program.pipe(
51-
Effect.provide(DevTools.layer()),
52-
NodeRuntime.runMain
53-
);
63+
program.pipe(Effect.provide(DevTools.layer()), NodeRuntime.runMain);
5464
```
5565

5666
### Custom Server URL
@@ -86,15 +96,7 @@ If you're using `@effect/opentelemetry`, provide the `DevTools` layer **before**
8696

8797
## Comparison with VS Code Extension
8898

89-
This TUI is a lightweight alternative focused on **observability**, not a full replacement for the VS Code extension.
90-
91-
### Features
92-
93-
- ✅ View Spans/Traces
94-
- ✅ Span Tree Navigation
95-
- ✅ Span Details (IDs, attributes, events)
96-
- ✅ Metrics Viewing
97-
- ✅ Multi-Client Support
99+
This TUI complements the VS Code extension by focusing on **observability and code analysis**, while the extension provides debugging capabilities and IDE integration.
98100

99101
## Related Projects
100102

0 commit comments

Comments
 (0)