Command Reference

Complete reference for all pfy CLI commands.

Command Structure

pfy [global-flags] <command> [subcommand] [flags]

Global Flags

Available on all commands:

Flag	Short	Description
--manager		Manager server URL
--token		Personal Access Token
--insecure-skip-tls-verify		Skip TLS verification (not for production)
--timeout		HTTP request timeout for Manager API calls (e.g. 30s, 1m; default: 30s)
--ci		CI/CD environment indicator
--verbose	-v	Verbose output with details
--quiet	-q	Suppress normal output
--version		Print the CLI binary's version and exit

No structured output

There is no --output/-o flag. Every command prints human-readable text only; JSON and YAML output are not implemented — see Known Issues.

Core Commands

Setup & Configuration

Command	Description
login	Authenticate with ProductifyFW manager
init	Initialize new project configuration
sync	Sync project configuration from manager
version	Manage project version (show/set/bump)

Not yet implemented

pfy logout, pfy whoami, and pfy env do not exist. Remove the saved token by editing ~/.pfy/config.yaml directly, and edit the environments section of project.yaml by hand — see Known Issues and Known Issues.

Resource Management

Command	Description
project	Manage projects - the top-level organization units
tenant	Manage tenants within projects for multi-tenancy
application	Manage application instances within tenants
languagepack	Manage internationalization language packs
pilet	Manage pilet packages for microfrontend applications

CI/CD & Deployment

Command	Description
ci	Generate and update CI/CD pipeline templates
nomad	Manage Nomad job deployments

Authentication

• login - Authenticate with Manager

Command Categories

By Function

Setup & Configuration

• login - Initial authentication
• init - Initialize project configuration
• sync - Sync from manager
• version - Version management

Project Hierarchy

• project - Top-level organization
• tenant - Multi-tenant isolation
• application - Deployable instances

Customization

• languagepack - Internationalization
• pilet - Microfrontend packages

CI/CD

• ci - Pipeline template generation
• nomad - Nomad job deployment

By Development Phase

Getting Started

# 1. Authenticate
pfy login --server https://manager.example.com --token <token>

# 2. Initialize project
pfy init --name my-app --language go

# 3. Generate CI/CD
pfy ci update

Development

# Bump version
pfy version bump --part patch

# Promote application (--slug is required)
pfy application promote --application-id <id> --target-tenant-id <tenant> --slug <slug>

Release & Deploy

# Bump version, regenerate CI templates, deploy to Nomad
pfy version bump --part minor
pfy ci update
pfy nomad deploy --use-project-version

Usage Patterns

Scripting Mode

--quiet suppresses normal output — it is for silencing a command, not for making it parseable. To match on output, use the default text format:

#!/bin/bash
pfy project list | grep "my-project"

CI/CD Mode

Use --ci flag for CI/CD environments:

pfy --ci nomad deploy -f nomad/prod/app.nomad --use-project-version

Getting Help

General Help

pfy --help

Command Help

pfy project --help
pfy project create --help

Common Patterns

Chaining Commands

# Get project ID and create tenant
PROJECT_ID=$(pfy project get --slug my-project | grep "ID:" | awk '{print $2}')
pfy tenant create --project-id $PROJECT_ID --slug tenant1 --name "Tenant 1"

Error Handling

if pfy project create --slug test --name "Test"; then
    echo "Project created successfully"
else
    echo "Failed to create project"
    exit 1
fi

Verbose Debugging

pfy --verbose project create --slug debug --name "Debug"

Next Steps

Explore detailed documentation for each command:

Setup Commands

• login - Authentication
• init - Initialize project configuration
• sync - Sync from manager
• version - Version management

Resource Management

• project - Project management
• tenant - Tenant management
• application - Application management
• languagepack - Language pack management
• pilet - Pilet package management

CI/CD

• ci - CI/CD pipeline template generation
• nomad - Nomad deployment management

Guides

• Project Configuration - Working with project.yaml
• Version Management - Semantic versioning
• Auto-Versioning - CI/CD version automation

For additional information, use pfy --help or pfy <command> --help to see all available options.