11# ** DevTUI** - A Swiss-army app for developers
22
3- ** DevTUI ** is an all -in-one terminal toolkit designed for developers. It consolidates your everyday utilities into a single, unified TUI (Text User Interface) and CLI (Command Line Interface). No more juggling multiple tools — everything you need is now just one command away .
3+ All -in-one terminal toolkit that consolidates everyday developer utilities into a unified TUI and CLI interfaces .
44
5- 🚀 Actively developed and continuously improving.
6-
7- ![ devtui] ( devtui.png )
5+ ![ devtui] ( /site/assets/img/devtui.png )
86
97## 💡 Why DevTUI?
108
@@ -24,153 +22,14 @@ brew install skatkov/tap/devtui
2422
2523Or download executable from [ GitHub Releases] ( https://github.com/skatkov/homebrew-tap/releases?q=devtui&expanded=true )
2624
27- ---
28-
29- ## 📋 Requirements
30-
31- ### macOS
32- - ✅ Works out of the box
33-
34- ### Linux
35-
36- - 🖱 Wayland requires: ` wl-clipboard `
37- - 🧮 X11 requires: ` xclip ` or ` xsel `
38-
39- To check your session type:
40- ``` bash
41- echo $XDG_SESSION_TYPE
42- # Output: wayland or x11
43- ```
44- ### Windows
45- - ⚠️ Not tested, but available.
46-
47- ---
48-
4925## 🚀 Docs
50- DevTUI includes both a TUI and CLI interface.
51-
52- ### 🖥 TUI
53- Run ` devtui ` you'll see a list of available tools — just pick one and go!
54-
55- ### Autocompletion
56- Run a one of these commands depending on shell
57-
58- ```
59- devtui completion bash > ~/.bashrc
60- devtui completion zsh > ~/.zshrc
61- devtui completion fish > ~/.fishrc
62- ```
63-
64- ### CLI (Experimental)
65- The CLI interface is still in development and may change in future versions.
66-
67- To include all markdown files from the ./docs folder, use the following syntax:
68-
69- ``` bash
70- find ./docs -name " *.md" -exec cat {} \;
71- ```
72-
73- #### 🎨 CSS Formatter
74- ``` bash
75- devtui cssfmt < testdata/bootstrap.min.css > output.css
76- ```
77-
78- Optional flags:
79- ```
80- -i, --indent int spaces for indentation (default 2)
81- --semicolon always end rule with semicolon, even if not needed (default true)
82- -t, --tab use tabs for indentation
83- ```
84- #### 🧼 CSS Minimizer
85- Strip unnecessary whitespace from CSS files:
86-
87- ``` bash
88- devtui cssmin < input.css > output.min.css
89- ```
90-
91- #### 🗂 XML Formatter
92- ``` bash
93- devtui xmlfmt < testdata/input.xml > output.xml
94- ```
95-
96- Optional flags:
97-
98- ```
99- -i, --indent string Indent string for nested elements (default " ")
100- -n, --nested Nested tags in comments
101- -p, --prefix string Each element begins on a new line and this prefix
102- ```
103-
104- #### 📝 GraphQL Query Formatter
105- Format GraphQL queries:
106-
107- ``` bash
108- devtui gqlfmt < testdata/query.graphql
109-
110- devtui gqlfmt < testdata/query.graphql > formatted.graphql
111- devtui gqlfmt --indent " " --with-comments --with-descriptions < testdata/query.graphql
112- ```
113-
114- Optional flags:
115- ```
116- -i, --indent string Indent string for nested elements (default is 2 spaces) (default " ")
117- -c, --with-comments Include comments in the formatted output
118- -d, --with-descriptions Include descriptions in the formatted output (omitted by default)
119- ```
120-
121- #### 🗒️ TSV to Markdown Table Converter
122- Convert TSV to Markdown Table:
123-
124- ``` bash
125- devtui tsv2md -t < example.tsv - convert tsv from stdin and view result in stdout
126-
127- devtui tsv2md < example.tsv > output.md - convert tsv from stdin and write result in new file
128-
129- cat example.tsv | devtui tsv2md - convert tsv from stdin and view result in stdout
130- ```
131-
132- Optional flags:
133- ```
134- -a, --align Align columns width
135- -t --header string Add main header (h1) to result
136- ```
137-
138- #### 🗒️ CSV to Markdown Table Converter
139- Convert CSV to Markdown Table:
140-
141- ``` bash
142- devtui csv2md -t < example.csv - convert csv from stdin and view result in stdout
143-
144- devtui csv2md < example.csv > output.md - convert csv from stdin and write result in new file
145-
146- cat example.csv | devtui csv2md - convert csv from stdin and view result in stdout
147- ```
148-
149- Optional flags:
150- ```
151- -a, --align Align columns width
152- -t --header string Add main header (h1) to result
153- ```
154-
155- #### 🗒️ TSV to CSV Converter
156- Convert TSV to CSV:
157-
158- ``` bash
159- devtui tsv2csv < testdata/input.tsv > output.csv
160- ```
161-
162- Optional flags:
163- ```
164- -i, --indent string Indent string for nested elements (default " ")
165- -n, --nested Nested tags in comments
166- -p, --prefix string Each element begins on a new line and this prefix
167- ```
26+ -> [ devtui.com/start] ( https://devtui.com/start )
16827
16928---
17029
17130## 📚 Documentation Generator
17231
173- DevTUI includes automated documentation generators for both CLI and TUI interfaces.
32+ DevTUI includes automated documentation generators for both CLI and TUI interfaces (not complete yet, though) .
17433
17534### Generate All Documentation
17635To regenerate both CLI and TUI documentation:
@@ -199,12 +58,10 @@ cd docs && go run tui-docs.go docs.go
19958---
20059
20160## Logo
61+ Logo was done by [ Andrei Kedrin] ( https://linktr.ee/andreikedrin ) .
62+
63+ Figma original:
20264https://www.figma.com/design/JTS0mzphMDiRuuC3xNprLu/Untitled?node-id=0-1&p=f&t=0LeB0uhXSUmZpE3Q-0
20365
20466## 🧑💻 Contact
205- I love when people reach out, so please don't hesitate to do that.
206-
207- 208- - [ https://t.me/skatkov ] ( https://t.me/skatkov )
209- - [ https://bsky.app/profile/skatkov.com ] ( https://bsky.app/profile/skatkov.com )
210- - [ https://x.com/5katkov ] ( https://x.com/5katkov )
67+
0 commit comments