tuidoscope 0.1.11 → 0.1.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +25 -2
- package/dist/index.js +2588 -360
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# tuidoscope
|
|
2
2
|
|
|
3
|
-
A centralized TUI management application for running multiple TUI applications in embedded terminal windows. Built with [OpenTUI](https://github.com/
|
|
3
|
+
A centralized TUI management application for running multiple TUI applications in embedded terminal windows. Built with [OpenTUI](https://github.com/anomalyco/opentui) and SolidJS.
|
|
4
4
|
|
|
5
5
|
## Screenshots
|
|
6
6
|
|
|
@@ -26,11 +26,21 @@ A centralized TUI management application for running multiple TUI applications i
|
|
|
26
26
|
- **Highly Configurable**: Customize themes, keybinds, and application lists via YAML.
|
|
27
27
|
- **Path Expansion**: Supports `~` and `<CONFIG_DIR>` tokens in working directory paths.
|
|
28
28
|
|
|
29
|
+
## Documentation
|
|
30
|
+
|
|
31
|
+
For detailed guides, see the [`docs/`](./docs/) directory:
|
|
32
|
+
|
|
33
|
+
- [Getting Started](./docs/getting-started.md) - Installation and first run
|
|
34
|
+
- [Configuration](./docs/configuration.md) - YAML config reference
|
|
35
|
+
- [Keybindings](./docs/keybindings.md) - Leader key system and shortcuts
|
|
36
|
+
- [Apps](./docs/apps.md) - App configuration examples
|
|
37
|
+
- [Troubleshooting](./docs/troubleshooting.md) - Common issues and solutions
|
|
38
|
+
|
|
29
39
|
## Tech Stack
|
|
30
40
|
|
|
31
41
|
- **Runtime**: [Bun](https://bun.sh/)
|
|
32
42
|
- **Framework**: [SolidJS](https://www.solidjs.com/)
|
|
33
|
-
- **TUI Engine**: [OpenTUI](https://github.com/
|
|
43
|
+
- **TUI Engine**: [OpenTUI](https://github.com/anomalyco/opentui)
|
|
34
44
|
- **Terminal Emulator**: [ghostty-opentui](https://github.com/remorses/ghostty-opentui)
|
|
35
45
|
- **PTY**: `node-pty` (via `spawn-pty`)
|
|
36
46
|
|
|
@@ -135,6 +145,19 @@ theme:
|
|
|
135
145
|
- Runtime application configuration (Add/Edit).
|
|
136
146
|
- Path expansion for working directories.
|
|
137
147
|
|
|
148
|
+
## Contributing
|
|
149
|
+
|
|
150
|
+
Contributions are welcome! Please feel free to open an issue or submit a pull request on [GitHub](https://github.com/shuv1337/tuidoscope).
|
|
151
|
+
|
|
152
|
+
## Acknowledgments
|
|
153
|
+
|
|
154
|
+
This project is built directly on top of:
|
|
155
|
+
|
|
156
|
+
- **[OpenTUI](https://github.com/anomalyco/opentui)** - Provides the declarative component model and rendering engine for the entire interface.
|
|
157
|
+
- **[ghostty-opentui](https://github.com/remorses/ghostty-opentui)** - Enables high-performance, embedded terminal sessions within the application.
|
|
158
|
+
|
|
159
|
+
Huge thanks to both for making this possible.
|
|
160
|
+
|
|
138
161
|
## License
|
|
139
162
|
|
|
140
163
|
MIT
|