Diagram is a CLI tool to generate hand drawn diagrams from ASCII arts.
It's a full featured CLI application which converts the ASCII text into hand drawn diagrams. The CLI part is based on gocui and the ascii to png conversion is done using the gg library.
$ go get github.com/esimov/diagram
$ go install
# Start the application
$ diagram
A shell script is included to watch the output folder changes and automatically open the generated png files, however inotifywait
is required for Linux distribution. To install on Ubuntu please run:
sudo apt install inotify-tools
Then you can use the provided shell script by typing $ ./watch
.
Key | Description |
---|---|
Tab | Next Panel |
Shift+Tab | Previous Panel |
Ctrl+s | Open Save Diagram Modal |
Ctrl+s | Save Diagram |
Ctrl+d | Convert Ascii to PNG |
Ctrl+x | Clear the editor content |
Ctrl+z | Restore the editor content |
PageUp | Jump to the top |
PageDown | Jump to the bottom |
Home | Jump to the start line |
End | Jump to the end line |
Ctrl+c | Quit |
Input | Output |
---|---|
The app was tested on Ubuntu and MacOS, but on Mac the panels are not selectables with clicks.
The ascii -> png conversion was ported from shaky.dart.
This project is under the MIT License. See the LICENSE file for the full license text.