Installation

Get Taskw installed and ready to generate code for your Go APIs.

Requirements

Before installing Taskw, ensure you have:

• Go 1.23+ installed on your system
• Wire installed on your system
• Swaggo installed on your system
• Taskfile installed on your system

Installation Methods

Choose the installation method that works best for your environment:

go install github.com/nkaewam/taskw@latest

taskw --help

# Linux/macOS
chmod +x taskw-*
sudo mv taskw-* /usr/local/bin/taskw

# Or add to your local bin directory
mkdir -p ~/bin
mv taskw-* ~/bin/taskw
# Add ~/bin to your PATH in ~/.bashrc or ~/.zshrc

taskw --help

git clone https://github.com/nkaewam/taskw.git
cd taskw

go build -o taskw main.go

sudo mv taskw /usr/local/bin/
# Or add to your local bin
mv taskw ~/bin/

taskw --help

Platform-Specific Notes

macOS

If you get a "developer cannot be verified" error:

1. Right-click the taskw binary
2. Select "Open" from the context menu
3. Click "Open" in the security dialog

Or use the command line:

xattr -d com.apple.quarantine taskw

Windows

• Use PowerShell or Command Prompt
• Add the taskw.exe location to your PATH environment variable
• Windows Defender may flag the binary initially - this is normal for new executables

Linux

• Most distributions work out of the box
• For older systems, you may need to install additional dependencies
• If using snap/flatpak Go, ensure $GOPATH/bin is accessible

Verify Your Installation

Test that Taskw is working correctly:

# Check version
taskw --version

# View help
taskw --help

# Test in a new directory
mkdir test-taskw && cd test-taskw
go mod init example.com/test-taskw
taskw init

You should see Taskw create a taskw.yaml configuration file.

Updating Taskw

From Go Install

go install github.com/nkaewam/taskw@latest

From Binary

Download the latest binary from the releases page and replace your existing installation.

Check Current Version

taskw --version

Troubleshooting

Command Not Found

Problem: taskw: command not found

Solutions:

• Go install users: Ensure $GOPATH/bin is in your $PATH
• Binary users: Verify the binary location is in your $PATH
• Check installation: Run which taskw (Linux/macOS) or where taskw (Windows)

Permission Denied

Problem: permission denied when running taskw

Solutions:

• Make the binary executable: chmod +x taskw
• Install with proper permissions: sudo mv taskw /usr/local/bin/
• Use a user-owned directory: ~/bin/ instead of /usr/local/bin/

Go Version Issues

Problem: Build errors or compatibility issues

Solutions:

• Update Go to version 1.21 or later: go.dev/doc/install
• Check your Go version: go version
• Use pre-built binaries if Go update isn't possible

Network Issues

Problem: Can't download with go install

Solutions:

• Check internet connection and proxy settings
• Use GOPROXY environment variable: GOPROXY=direct go install github.com/nkaewam/taskw@latest
• Download pre-built binary instead

Next Steps

Now that Taskw is installed:

1. Learn the basics → Quick Start Guide
2. Configure your project → Configuration Reference
3. See examples → Example Projects
4. Get help → Troubleshooting Guide

Need help? Join our GitHub Discussions or open an issue.