Skip to content

Installation

Install the pfy CLI to manage your ProductifyFW projects from the command line.

Prerequisites

  • ProductifyFW Manager - A running Manager instance with GraphQL API access

Install from GitHub Releases

Download the latest release for your platform:

Linux (amd64)

bash
# Download the latest release
curl -LO https://github.com/ProductifyFW/cli/releases/latest/download/pfy-linux-amd64

# Make it executable
chmod +x pfy-linux-amd64

# Move to a directory in your PATH
sudo mv pfy-linux-amd64 /usr/local/bin/pfy

Linux (arm64)

bash
curl -LO https://github.com/ProductifyFW/cli/releases/latest/download/pfy-linux-arm64
chmod +x pfy-linux-arm64
sudo mv pfy-linux-arm64 /usr/local/bin/pfy

macOS (Intel)

bash
curl -LO https://github.com/ProductifyFW/cli/releases/latest/download/pfy-darwin-amd64
chmod +x pfy-darwin-amd64
sudo mv pfy-darwin-amd64 /usr/local/bin/pfy

macOS (Apple Silicon)

bash
curl -LO https://github.com/ProductifyFW/cli/releases/latest/download/pfy-darwin-arm64
chmod +x pfy-darwin-arm64
sudo mv pfy-darwin-arm64 /usr/local/bin/pfy

Windows

Download the appropriate executable from the releases page:

  • pfy-windows-amd64.exe for 64-bit Windows
  • Add the directory to your PATH environment variable

Install Specific Version

To install a specific version, replace latest with the version tag:

bash
# Example: Install v1.2.3
curl -LO https://github.com/ProductifyFW/cli/releases/download/v1.2.3/pfy-linux-amd64
chmod +x pfy-linux-amd64
sudo mv pfy-linux-amd64 /usr/local/bin/pfy

Shell Completion

Enable auto-completion for your shell:

Bash

bash
source <(pfy completion bash)

# Add to your ~/.bashrc for persistence
echo 'source <(pfy completion bash)' >> ~/.bashrc

Zsh

bash
source <(pfy completion zsh)

# Add to your ~/.zshrc for persistence
echo 'source <(pfy completion zsh)' >> ~/.zshrc

Fish

bash
pfy completion fish | source

# Add to your ~/.config/fish/config.fish for persistence
echo 'pfy completion fish | source' >> ~/.config/fish/config.fish

Verify Installation

Check that the CLI is installed correctly:

bash
pfy --version

You should see output with version information and build time.

Next Steps

After installation:

  1. Authenticate with your Manager
  2. Follow the Quick Start Guide
  3. Explore available commands

Troubleshooting

Command not found

If you get pfy: command not found:

  1. Ensure the binary is in your PATH:

    bash
    which pfy
  2. Check your shell's PATH variable:

    bash
    echo $PATH
  3. Reload your shell configuration:

    bash
    source ~/.bashrc  # or ~/.zshrc

Permission denied

If you encounter permission errors:

bash
chmod +x /path/to/pfy

Build failures

Ensure you have Go 1.25+ installed:

bash
go version

Update dependencies if needed:

bash
go mod download
go mod tidy