Commit a5293f1
docs: correct CLI build and run paths in AGENTS.md (#344)
AGENTS.md referenced `cmd/hookdeck/main.go` as the CLI entrypoint, but
there is no `cmd/` directory in this repo — the entrypoint is `main.go`
at the repo root. Following the documented build command failed with
"no such file or directory".
Replace all six occurrences with `go build -o hookdeck .` and `go run .`,
using the package path rather than the single file so the build includes
every file in the root package. Both forms verified against the current
tree.
This matters more than a typical docs typo: AGENTS.md is the file agents
read to learn how to build this repo, so a wrong build command here is an
instruction that every future agent follows and fails on.
Claude-Session: https://claude.ai/code/session_013P3MKxbE4rQEYLuz5XR7eA
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>1 parent 45bbde2 commit a5293f1
1 file changed
Lines changed: 6 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -9,7 +9,7 @@ This repository contains the Hookdeck CLI, a Go-based command-line tool for mana | |||
| 9 | 9 | - `pkg/hookdeck/` - API client and models | |
| 10 | 10 | - `pkg/config/` - Configuration management | |
| 11 | 11 | - `pkg/listen/` - Local webhook forwarding functionality | |
| 12 | - - `cmd/hookdeck/` - Main entry point | ||
| 12 | + - `main.go` - Main entry point (repo root) | ||
| 13 | 13 | - `REFERENCE.md` - Complete CLI documentation and examples | |
| 14 | 14 | ||
| 15 | 15 | ### Key Files | |
@@ -240,7 +240,7 @@ This applies to **`go test`**, **`go mod download`**, **`git`**, **`gh`**, build | |||
| 240 | 240 | ### Building and Testing | |
| 241 | 241 | ```bash | |
| 242 | 242 | # Build the CLI | |
| 243 | - go build -o hookdeck cmd/hookdeck/main.go | ||
| 243 | + go build -o hookdeck . | ||
| 244 | 244 | ||
| 245 | 245 | # Run all unit tests (default packages; run from repo root) | |
| 246 | 246 | go test ./... | |
@@ -317,10 +317,10 @@ go vet ./... | |||
| 317 | 317 | ### Local Development | |
| 318 | 318 | ```bash | |
| 319 | 319 | # Run CLI directly during development | |
| 320 | - go run cmd/hookdeck/main.go <command> | ||
| 320 | + go run . <command> | ||
| 321 | 321 | ||
| 322 | 322 | # Example: Test login command | |
| 323 | - go run cmd/hookdeck/main.go login --help | ||
| 323 | + go run . login --help | ||
| 324 | 324 | ``` | |
| 325 | 325 | ||
| 326 | 326 | ### Sandbox and command execution | |
@@ -430,8 +430,8 @@ Acceptance tests in `test/acceptance/` are partitioned by **feature build tags** | |||
| 430 | 430 | ||
| 431 | 431 | | Command | Purpose | | |
| 432 | 432 | |---------|---------| | |
| 433 | - | `go run cmd/hookdeck/main.go --help` | View CLI help | | ||
| 434 | - | `go build -o hookdeck cmd/hookdeck/main.go` | Build CLI binary | | ||
| 433 | + | `go run . --help` | View CLI help | | ||
| 434 | + | `go build -o hookdeck .` | Build CLI binary | | ||
| 435 | 435 | | `go test ./...` | All unit tests (repo root; agents: run with `required_permissions: ["all"]`) | | |
| 436 | 436 | | `go test ./pkg/cmd/` | Test command implementations only | | |
| 437 | 437 | | `go generate ./...` | Run code generation (if used) | | |
0 commit comments