usage

name	usage
description	Use playfab-cli as the default interface for PlayFab service automation. Use when the user asks how to verify the CLI, check connectivity, list available tools, configure settings, or troubleshoot playfab-cli setup. Do not use once a more specific catalog, inventory, player, or other domain skill clearly matches the task.
allowed-tools	Bash, Read, Grep, Glob
metadata	{"author":"akiojin","version":"0.2.0","category":"foundation"}

PlayFab CLI Usage

General usage guide for the playfab-cli command-line tool.

Use When

• The user asks how to install, set up, or verify playfab-cli connectivity.
• The user needs help with system ping, config show, tool list, or --output json.
• The user asks whether to use tool call or batch for their task.
• The task is blocked on CLI setup, environment variables, or connection troubleshooting.

Do Not Use When

• A more specific PlayFab domain skill (catalog, inventory, player, etc.) already covers the requested task.
• The user only wants to inspect or edit Rust source files without using the CLI.

Prerequisites

Set the following environment variables before using the CLI:

export PLAYFAB_TITLE_ID=your_title_id
export PLAYFAB_DEV_SECRET_KEY=your_secret_key

Global Options

Option	Description
--output text|json	Output format (default: text)
-v, --verbose	Increase verbosity (use -vv for debug)
--dry-run	Preview the request without executing

Commands

Tool Operations

# List all available tools
playfab-cli tool list

# Show JSON schema for a tool
playfab-cli tool schema <tool_name>

# Call a tool with JSON parameters
playfab-cli tool call <tool_name> --json '{...}'

# Call a tool with parameters from a file
playfab-cli tool call <tool_name> --params-file params.json

System Commands

# Check connectivity to PlayFab
playfab-cli system ping

Configuration

# Show current configuration
playfab-cli config show

# Set a configuration value
playfab-cli config set <key> <value>

Batch Operations

# Execute batch operations from JSON
playfab-cli batch --json '[{"tool": "search_items", "params": {...}}, ...]'

# Execute batch operations from stdin
cat operations.json | playfab-cli batch --stdin

CLI Management

# Install or update the CLI binary
playfab-cli cli install
playfab-cli cli install --force

# Check CLI health
playfab-cli cli doctor

Examples

# Verify setup
playfab-cli system ping
playfab-cli config show

# Explore available tools
playfab-cli tool list
playfab-cli tool schema search_items

# Use JSON output for scripting
playfab-cli --output json tool call search_items --json '{"search": "sword"}'

# Dry run before executing
playfab-cli --dry-run tool call delete_item --json '{"id": "item-123"}'

# Batch operations
playfab-cli batch --json '[{"tool": "search_items", "params": {"search": "sword"}}]'

Common Workflows

1. Verify Setup

playfab-cli system ping
playfab-cli config show

2. Explore Available Tools

playfab-cli tool list
playfab-cli tool schema search_items

3. Use JSON Output for Scripting

playfab-cli --output json tool call search_items --json '{"search": "sword"}'

4. Dry Run Before Executing

playfab-cli --dry-run tool call delete_item --json '{"id": "item-123"}'

Notes

• All tool calls require PLAYFAB_TITLE_ID and PLAYFAB_DEV_SECRET_KEY environment variables.
• Use --output json for machine-readable output in automation workflows.
• The --dry-run flag previews requests without executing them — useful for destructive operations.
• The batch command supports parallel execution of multiple tool calls.