Development

Development

Build, test, pprof and the indexarr-def CLI.

Repository: buzzqw/indexarr.

Build and test

make test    # go test ./...
make vet     # go vet ./...
make qa      # vet + test + HTTP smoke test on the real binary
make build   # bin/indexarr
make release # linux/amd64, linux/arm64, windows/amd64, darwin/arm64 binaries
make ui-smoke  # UI smoke test
make ci      # local CI, log in ci-logs/<commit>.log

For memory/goroutine diagnosis, pprof can be exposed only on localhost:

INDEXARR_PPROF=127.0.0.1:6060 ./bin/indexarr -config data/indexarr.json
go tool pprof -top http://127.0.0.1:6060/debug/pprof/heap

The definitions CLI is indexarr-def:

go run ./cmd/indexarr-def validate examples/definitions
go run ./cmd/indexarr-def check-fixtures examples/definitions/html-forum.yaml
go run ./cmd/indexarr-def convert-cardigann -o ./native ./definizioni-da-studiare
go run ./cmd/indexarr-def fmt -w examples/definitions/html-forum.yaml
go run ./cmd/indexarr-def fingerprint examples/definitions/html-forum.yaml
go run ./cmd/indexarr-def schema
make def-validate   # example definitions and catalog, if present

Package structure and design choices: Architecture. User manual: User manual in English, Manuale utente in Italian. Torznab API: Torznab API; administrative JSON API: Admin JSON API. Test suite and smoke test: QA.

---

Part of the indexarr documentation.