🎛️ Pixelle CLI Complete Command Reference

September 4, 2025 · View on GitHub

This document provides detailed information about all Pixelle MCP CLI commands and options.

📋 Table of Contents

🚀 Basic Usage

Installation Methods & Invocation

pip install Method

# Install
pip install -U pixelle

# Use
pixelle [command] [options]

uvx Method

# Use directly without installation
uvx pixelle@latest [command] [options]

uv run Method

# Use in project directory
uv run pixelle [command] [options]

Default Behavior

# Enter interactive mode when no parameters
pixelle
uvx pixelle@latest
uv run pixelle

🔧 Service Management Commands

start - Start Service

pixelle start [options]

Options:

  • --daemon, -d: Run in background daemon mode
  • --force, -f: Force start (terminate conflicting processes)

Examples:

# Start in foreground
pixelle start

# Start in background
pixelle start --daemon
pixelle start -d            # Short form

# Force start (if port is occupied)
pixelle start --force
pixelle start -f            # Short form

# Background force start
pixelle start --daemon --force
pixelle start -d -f         # Short form
pixelle start -df           # Combined short form

stop - Stop Service

pixelle stop

Stops all Pixelle MCP related processes.

status - Check Status

pixelle status

Displays:

  • Service running status
  • Process information
  • Port usage
  • Configuration status

📄 Log Management

logs - View Logs

pixelle logs [options]

Options:

  • --follow, -f: Follow log output in real-time
  • --lines N, -n N: Show last N lines (default: 50)

Examples:

# View last 50 lines
pixelle logs

# View last 100 lines
pixelle logs --lines 100
pixelle logs -n 100         # Short form

# Follow logs in real-time
pixelle logs --follow
pixelle logs -f             # Short form

# Follow last 200 lines in real-time
pixelle logs --follow --lines 200
pixelle logs -f -n 200      # Short form
pixelle logs -fn 200        # Combined short form

⚙️ Configuration Management Commands

init - Initialize Configuration

pixelle init

Runs configuration wizard to set up:

  • ComfyUI connection
  • LLM providers
  • Service configuration

edit - Edit Configuration

pixelle edit

Provides configuration editing options:

  • Direct configuration file editing
  • Wizard-based reconfiguration of specific parts

📊 Information Commands

workflow - Workflow Information

pixelle workflow

Displays:

  • Loaded workflows
  • Available MCP tools
  • Workflow file paths
  • Tool statistics

dev - Development Information

pixelle dev

Shows detailed system information:

  • System environment
  • Dependency versions
  • Detailed service status
  • Debug information

🎯 Interactive Mode

interactive - Explicitly Enter Interactive Mode

pixelle interactive

Menu options in interactive mode:

  • 🚀 [start] Start Pixelle MCP service
  • 🔄 [init] Initialize/reconfigure Pixelle MCP
  • 📝 [edit] Edit configuration files
  • 🔧 [workflow] View workflow information and loaded tools
  • 🐛 [dev] Development mode and detailed system status
  • ❓ [help] Show help information
  • ❌ Exit Exit the program

🛠️ Advanced Options

Global Options

pixelle --help    # Show help information
pixelle -h        # Short form

📝 Usage Tips

1. Quick Start Process

# First time use
pixelle            # Enter interactive mode, complete configuration
# Select [init] to complete initialization
# Select [start] to start service

# Subsequent use
pixelle start      # Start directly

2. Debugging Issues

# View detailed status
pixelle status

# View development information
pixelle dev

# View real-time logs
pixelle logs --follow
pixelle logs -f             # Short form

3. Configuration Management

# Reconfigure
pixelle init

# Edit specific configuration
pixelle edit

4. Workflow Management

# View loaded workflows
pixelle workflow

# View workflow statistics
pixelle status

❓ Frequently Asked Questions

Q: How to reset all configuration?

# Re-run initialization wizard
pixelle init

Q: What to do if service fails to start?

# Check detailed status
pixelle status

# Force start
pixelle start --force
pixelle start -f            # Short form

# View error logs
pixelle logs

Q: How to update workflows?

# Restart service to automatically reload
pixelle stop
pixelle start

# Or check workflow status
pixelle workflow

Q: How to see all available commands?

pixelle --help
pixelle -h              # Short form