code.ivysaur.me/webcmd
1
0
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity

doc: top-level README

Browse Source
This commit is contained in:
mappu 2018-12-31 18:13:06 +13:00
parent 63b573fd57
commit d730fe65f6
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
_dist/README.txt → README.md
View File

@ -1,27 +1,24 @@
# webcmd
A web-based interface for arbitrary command-line tools.
Configure the possible options for your command (e.g. optional flags, custom arguments) and then remotely invoke the tool via a web interface. The web interface displays stdout/stderr of recent and in-progress tasks, and can cancel a long-running command at any time.
Written in Golang
## Usage
=USAGE=
`Usage of ./webcmd:
```
Usage of ./webcmd:
-config string
Path to configuration file (default "webcmd.conf")
-version
Display version number and exit`
Display version number and exit
```
=CONFIGURATION=
## Configuration
See the included `webcmd.conf-sample` file for an example configuration implementing a Looking Glass server over the top of `/bin/ping`.
=GO GET=
This package can be installed via go get: `go get code.ivysaur.me/webcmd`
[go-get]code.ivysaur.me/webcmd git https://git.ivysaur.me/code.ivysaur.me/webcmd.git[/go-get]
=CHANGELOG=
## Changelog
2017-03-27 1.0.1
- Enhancement: Simplify configuration file format, allow parsing const strings directly