mirror of
https://github.com/deuill/grawkit.git
synced 2024-09-28 08:22:46 +00:00
Alex Palaistras
24d63cd8a9
Running `grawkit` locally can be a hassle for one-off tasks, and can be hard to iterate against when plotting graphs based on complex command-line descriptions. Given recent fixes for POSIX compatibility, this commit implements a basic web-based "playground"-style application that allows for entering command-line descriptions in an HTML textarea, and seeing the results (or errors) instantly. The playground application itself is built in Go (Awk itself would be insufficient for the throughput required, but may be investigated in the future), with the excellent GoAwk library providing parsing and execution duties, therefore making for a pure-Go implementation (other than Grawkit itself). Additional support for setting custom styling and an online deployment with Docker are forthcoming.
22 lines
1.1 KiB
Markdown
22 lines
1.1 KiB
Markdown
# The Grawkit Playground
|
|
|
|
This folder contains an interactive version of Grawkit that can be run in a web-browser (Javascript
|
|
support optional), built entirely in Go. Once built, this depends only on the contents of the
|
|
`static` directory, as well as the `grawkit` script itself for operation.
|
|
|
|
Execution of Grawkit is done with [`goawk`](https://github.com/benhoyt/goawk), a POSIX-compatible
|
|
AWK implementation built entirely in Go, and used here as a library.
|
|
|
|
## Installation & Usage
|
|
|
|
Only a fairly recent version of Go is required to build this package, and the included `play.go`
|
|
file can be executed on-the-fly using `go run`.
|
|
|
|
The program expects to find a `static` directory (which is provided alongside the source code
|
|
here), as well as the `grawkit` script; by default, these are expected to be found in the current
|
|
and parent directories, respectively. Alternatively, their locations may be set using command-line
|
|
arguments, run `play -help` for more.
|
|
|
|
By default, this will bind an HTTP server on port `8080`, though this can also be modified using
|
|
the command-line arguments. Run `play -help` for more.
|