{"id":17269814,"url":"https://github.com/titpetric/task-ui","last_synced_at":"2025-05-12T04:30:27.418Z","repository":{"id":177917982,"uuid":"661087319","full_name":"titpetric/task-ui","owner":"titpetric","description":"Task UI - a web based runner for Taskfile.yml","archived":false,"fork":false,"pushed_at":"2025-05-09T09:51:30.000Z","size":246,"stargazers_count":56,"open_issues_count":0,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-09T10:42:30.521Z","etag":null,"topics":["automation","deployments","deploys","docker","golang","make","makefile","task","taskfile","terminal","websocket"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/titpetric.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"titpetric","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-07-01T18:44:29.000Z","updated_at":"2025-05-09T09:51:33.000Z","dependencies_parsed_at":"2024-10-27T12:52:08.486Z","dependency_job_id":"2b32fffd-c651-4af1-ade8-680d7b256282","html_url":"https://github.com/titpetric/task-ui","commit_stats":null,"previous_names":["titpetric/task-ui"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/titpetric%2Ftask-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/titpetric%2Ftask-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/titpetric%2Ftask-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/titpetric%2Ftask-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/titpetric","download_url":"https://codeload.github.com/titpetric/task-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253675028,"owners_count":21945884,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","deployments","deploys","docker","golang","make","makefile","task","taskfile","terminal","websocket"],"created_at":"2024-10-15T08:17:40.033Z","updated_at":"2025-05-12T04:30:27.386Z","avatar_url":"https://github.com/titpetric.png","language":"Go","readme":"# Task UI\n\nRun your `Taskfile.yml` from the browser.\n\n![](https://raw.githubusercontent.com/titpetric/task-ui/main/.github/assets/task-ui.png)\n\nStart the Docker image with `task docker:run`.\n\nTask UI is meant for Docker environments. A generic Dockerfile exists, which\nbundles typical dependencies like `task`, `ttyrec`, `docker`, `docker compose`.\n\nTo use, start by navigating to the\n[docker](https://github.com/titpetric/task-ui/tree/main/docker)\nsubfolder. It contains a Taskfile, with the typical commands to build and\nrun task-ui from a Docker image. For examples with Taskfiles you could\nrun, look into the folder\n[examples](https://github.com/titpetric/task-ui/tree/main/examples).\n\nThe layout is somewhat responsive, supporting mobile.\n\n# Running\n\nTo set up your project to run with Task UI, it's recommended you use the\nexample Docker Compose setup here:\n\n```yaml\nservices:\n  runner:\n    image: titpetric/task-ui\n    restart: always\n    build: .\n    command:\n      - --history-enable\n    ports:\n    - 3000:3000\n    volumes:\n    - $PWD/app:/app\n    - /var/run/docker.sock:/var/run/docker.sock:ro\n```\n\nIn particular, you should mount your `/app` folder which contains your\n`Taskfile.yml`, `docker-compose.yml` and other files. Task UI will run\nwith what you provide it with.\n\n- If you don't want history, remove the `command` flags.\n- If you don't want to use Docker, remove the volume for `docker.sock`.\n\nThe image provides an `id_ecdsa` key to use for SSH hops. The recommended\nway to deploy is to provide your own `docker/root/.ssh` folder with\nthe SSH keys. You can regenerate the SSH key with `task docker:gen`.\n\n# Development\n\ntask: Available tasks for this project:\n\n* default:            Run everything\n* fix:                Fix code\n* install:            Install task-ui\n* run:                Run task-ui\n* test:               Test task-ui\n* docker:build:       Build task-ui docker image\n* docker:gen:         Generate ssh key for docker image\n* docker:run:         Run task-ui in docker env\n\n## task: default\n\nRun everything\n\ncommands:\n- `Task: fix`\n- `Task: install`\n- `Task: test`\n\n## task: test\n\nTest task-ui\n\ncommands:\n- `CGO_ENABLED=1 go test -race -count=1 -cover ./...`\n- `CGO_ENABLED=0 go test -count=1 -cover ./...`\n\n## task: run\n\nRun task-ui\n\ncommands:\n- `task-ui --history-enable`\n\n## task: install\n\nInstall task-ui\n\ncommands:\n- `CGO_ENABLED=0 go install .`\n\n## task: fix\n\nFix code\n\ndependencies:\n- `deps:goimports`\n\ncommands:\n- `goimports -w .`\n- `go fmt ./...`\n- `go vet .`\n- `go mod tidy`\n- `./README.md.sh \u003e README.md`\n\n","funding_links":["https://github.com/sponsors/titpetric"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftitpetric%2Ftask-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftitpetric%2Ftask-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftitpetric%2Ftask-ui/lists"}