Skip to content

BrunnerLivio/tsp-web

Repository files navigation

tsp-web

Task Spooler real-time Web UI.

TSP Web Preview

Installation

  1. Make sure you have task-spooler installed on your system

  2. Download the tsp-web binary from our releases page

  3. Make it executable

chmod +x ./tsp-web*
  1. Run it
./tsp-web*
# Mac: If you're using the Brew package you might wanna change the task spooler binary
TSP_WEB_TS_BIN=ts ./tsp-web*
  1. Run your first task
tsp -L sleep sleep 30
# Mac:
ts -L sleep sleep 30

Arguments and Environment variables

Argument Environment Description Example Default
--ts-bin TSP_WEB_TS_BIN The binary name of TSP tsp (for Linux)
ts (for Mac)
tsp
--port TSP_WEB_POST The port number to run TSP-Web on 8080 3000
--host TSP_WEB_HOSTNAME The hostname to run TSP-Web on 192.168.0.20 localhost
--log-level TSP_WEB_LOG_LEVEL The log level can be 'debug' or 'info' or 'warn' warn info
--no-color - Whether the logs should be displayed without colors - false
--version - Prints the version -

Configuration

The configuration of tsp-web can be found in the folder $XDG_CONFIG_HOME/tsp-web/config.yml (default ~/.config/tsp-web/config.yml).

commands:
  - name: "Sleep"
    args: ["-L", "sleep", "sleep", "30"]

labels:
  - name: sleep
    bgColor: '#0C2880'
    fgColor: 'black'
    icon: 💤