Skip to content
Open
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
14 changes: 11 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,18 @@
# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/
# Dependency directories
vendor/

# Go workspace file
go.work

.idea/
# Jetbrains IDEs
.idea/

# Generated binary
duck-gen

# AI tools
.claude/
CLAUDE.md
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,26 @@ embargo-frisk-rack@duck.com
## Installation

Download pre-built binaries from the [Releases](https://github.com/chowder/duck-gen/releases) page

### Building from Source

1. **Install Go** (requires Go 1.23.2 or later):
- Download from https://go.dev/dl/

2. **Clone and build**:
```bash
git clone https://github.com/chowder/duck-gen.git
cd duck-gen
go mod vendor
go build -mod=vendor
```

This will create a `duck-gen` binary in the current directory.

3. **Install to your PATH** (optional):
```bash
go install
```
This installs the binary to `$GOPATH/bin` or `$HOME/go/bin` (add to your PATH if needed).

> Alternatively, you can move the binary to anywhere you like and put an alias to it in your `.bash_aliases`, `.bashrc`, `.zsh_aliases` or `.zshrc`.