Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions Taskfile.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
# yaml-language-server: $schema=https://taskfile.dev/schema.json
version: "3"

vars:
BINARY_NAME: dreadgoad
CMD_PATH: .

includes:
go:
taskfile: "https://raw.githubusercontent.com/CowDogMoo/taskfile-templates/main/go/Taskfile.yaml"
dir: ./cli
vars:
BINARY_NAME: '{{.BINARY_NAME}}'
CMD_PATH: '{{.CMD_PATH}}'
ansible:
taskfile: "https://raw.githubusercontent.com/CowDogMoo/taskfile-templates/main/ansible/Taskfile.yaml"
dir: ./ansible

tasks:
default:
desc: Build, test, and clean
cmds:
- task: go:default

install:
desc: Install the dreadgoad binary to GOPATH/bin
cmds:
- task: go:install
15 changes: 15 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# DreadGOAD CLI Reference

## Installation

Install the `dreadgoad` binary to your `GOPATH/bin` using the project Taskfile:

```bash
task install
```

This runs `go install` from the `cli/` module and drops the binary in
`$(go env GOPATH)/bin`. Ensure that directory is on your `PATH`, then run
`dreadgoad --help` to confirm the install.

Run `task --list` to see all available tasks. `task` (no arguments) builds,
tests, and cleans the CLI.

## Commands

Run `dreadgoad <command> --help` for full flag listings. Major commands:
Expand Down
Loading