Skip to content

getting-started.md

Latest commit

 

History

History
49 lines (34 loc) · 1.11 KB

getting-started.md

File metadata and controls

49 lines (34 loc) · 1.11 KB
Raw

Getting started

1. Install without Go

Once GitHub Releases exist:

  1. Download the asset for your OS/arch, e.g. godo_0.1.0_darwin_arm64 (bare) or the .tar.gz / .zip
  2. chmod +x godo (Unix)
  3. Move it onto your $PATH
  4. Check: godo --version

Full detail: install.md.

With Go available:

go install github.com/my-rv/godo/cmd/godo@latest

2. Add a catalog

Create godo.yaml at the repo root (2-space indent):

version: "0.1"

scripts:
  test: go test ./...
  vet: go vet ./...
  # @deps vet, test
  check: go build -o app .

version is required. engine.dialect is optional and defaults to package. Script docs and @deps / @dialect are comments immediately above each key — start with guide/scripts.md.

3. Run

godo test
godo --preview check   # see expanded lines, no exec
godo --ls              # list scripts

4. Next