diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 65c6501..9c51da6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,12 +20,15 @@ make build # build common macOS, Linux, and Windows binaries into bin/ make build-cross -# install the CLI with go install and install the AI skill +# install the CLI with go install make install # install only the AI skill into common tool directories make install-skill +# install both the CLI and the AI skill +make install-all + # show all available make targets make help ``` diff --git a/Makefile b/Makefile index c7bf0a5..317a65b 100644 --- a/Makefile +++ b/Makefile @@ -8,19 +8,20 @@ SKILL_SOURCE_DIR := .ai/skills/$(SKILL_NAME) AI_SKILL_DIRS ?= $(HOME)/.codex/skills $(HOME)/.claude/skills $(HOME)/.config/claude/skills $(HOME)/.cursor/skills $(HOME)/.windsurf/skills CROSS_PLATFORMS := darwin/amd64 darwin/arm64 linux/amd64 linux/arm64 windows/amd64 windows/arm64 -.PHONY: all build build-cross install install-skill test test-cover clean help +.PHONY: all build build-cross install install-skill install-all test test-cover clean help all: build help: @echo "Targets:" - @echo " make build Build $(BINARY) into $(BUILD_DIR)/" - @echo " make build-cross Build common cross-platform binaries into $(BUILD_DIR)/" - @echo " make install Install $(BINARY) with 'go install'" - @echo " make install-skill Install .ai skill into common AI tool skill dirs" - @echo " make test Run unit tests" - @echo " make test-cover Run unit tests with coverage" - @echo " make clean Remove build artifacts" + @printf " %-18s %s\n" "make build" "Build $(BINARY) into $(BUILD_DIR)/" + @printf " %-18s %s\n" "make build-cross" "Build common cross-platform binaries into $(BUILD_DIR)/" + @printf " %-18s %s\n" "make install" "Install $(BINARY) with 'go install'" + @printf " %-18s %s\n" "make install-skill" "Install .ai skill into common AI tool skill dirs" + @printf " %-18s %s\n" "make install-all" "Install $(BINARY) and the .ai skill" + @printf " %-18s %s\n" "make test" "Run unit tests" + @printf " %-18s %s\n" "make test-cover" "Run unit tests with coverage" + @printf " %-18s %s\n" "make clean" "Remove build artifacts" build: @mkdir -p $(BUILD_DIR) @@ -40,7 +41,7 @@ build-cross: CGO_ENABLED=0 GOOS=$$goos GOARCH=$$goarch go build -trimpath -ldflags="-s -w" -o "$$output" $(PKG); \ done -install: install-skill +install: go install $(PKG) install-skill: @@ -53,6 +54,8 @@ install-skill: echo "Installed $(SKILL_SOURCE_DIR) -> $$target"; \ done +install-all: install install-skill + test: go test ./... diff --git a/README.md b/README.md index 810abc7..ff76090 100644 --- a/README.md +++ b/README.md @@ -42,12 +42,27 @@ make build ./bin/rollbar-cli --help ``` +### Install the CLI from this checkout + +```bash +make install +``` + ### Install the optional AI skill ```bash make install-skill ``` +### Install both the CLI and the AI skill + +```bash +make install-all +``` + +`make install` installs only the `rollbar-cli` binary from your current checkout. `make install-skill` installs only +the AI skill. Use `make install-all` if you want both. + ## Quick start ```bash