{
  "type": "featherpanel.cli.all",
  "generated_at": "2026-10-09T12:14:41.409Z",
  "global_flags": [
    {
      "flag": "--skip-path-check",
      "description": "Skip CWD validation. Required in CI and some container contexts where cwd is not /var/www/featherpanel or /var/www/html."
    },
    {
      "flag": "--no-colors",
      "description": "Disable Minecraft-style color codes in CLI output."
    },
    {
      "flag": "--clean-output",
      "description": "Strip decorative formatting for machine-friendly output."
    },
    {
      "flag": "--no-prefix",
      "description": "Omit the [FeatherPanel] prefix on each output line."
    }
  ],
  "production_wrapper": "featherpanel",
  "docker_container": "featherpanel_backend",
  "entrypoint": "php cli",
  "commands": [
    {
      "name": "cron",
      "class_name": "Cron",
      "description": "Run all scheduled cron jobs",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/Cron.php",
      "invoke": {
        "production": "featherpanel cron",
        "docker": "docker exec -it featherpanel_backend php cli cron",
        "source_dev": "cd /var/www/featherpanel/backend && php cli cron"
      }
    },
    {
      "name": "developer",
      "class_name": "Developer",
      "description": "Manage developer server and VS Code Tunnel (start, stop, status, logs)",
      "subcommands": [
        {
          "name": "start",
          "description": "Start the developer server and VS Code Tunnel"
        },
        {
          "name": "stop",
          "description": "Stop the developer server and VS Code Tunnel"
        },
        {
          "name": "status",
          "description": "Check if the developer server is running"
        },
        {
          "name": "logs",
          "description": "Show VS Code Tunnel logs (usage: developer logs [lines])"
        }
      ],
      "source": "backend/app/Cli/Commands/Developer.php",
      "invoke": {
        "production": "featherpanel developer",
        "docker": "docker exec -it featherpanel_backend php cli developer",
        "source_dev": "cd /var/www/featherpanel/backend && php cli developer"
      }
    },
    {
      "name": "help",
      "class_name": "Help",
      "description": "Get help for all commands",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/Help.php",
      "invoke": {
        "production": "featherpanel help",
        "docker": "docker exec -it featherpanel_backend php cli help",
        "source_dev": "cd /var/www/featherpanel/backend && php cli help"
      }
    },
    {
      "name": "logs",
      "class_name": "Logs",
      "description": "Upload the logs to MythicalSystems Paste!",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/Logs.php",
      "invoke": {
        "production": "featherpanel logs",
        "docker": "docker exec -it featherpanel_backend php cli logs",
        "source_dev": "cd /var/www/featherpanel/backend && php cli logs"
      }
    },
    {
      "name": "migrate",
      "class_name": "Migrate",
      "description": "Migrate the database to the latest version",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/Migrate.php",
      "invoke": {
        "production": "featherpanel migrate",
        "docker": "docker exec -it featherpanel_backend php cli migrate",
        "source_dev": "cd /var/www/featherpanel/backend && php cli migrate"
      }
    },
    {
      "name": "module",
      "class_name": "Module",
      "description": "Manage FeatherPanel modules (install, ensure, list, uninstall)",
      "subcommands": [
        {
          "name": "install",
          "description": "Install a module (usage: module install <module>)"
        },
        {
          "name": "ensure",
          "description": "Reinstall a module if its install marker exists but files are missing (usage: module ensure <module>)"
        },
        {
          "name": "list",
          "description": "List available and installed modules"
        },
        {
          "name": "uninstall",
          "description": "Uninstall a module (usage: module uninstall <module>)"
        }
      ],
      "source": "backend/app/Cli/Commands/Module.php",
      "invoke": {
        "production": "featherpanel module",
        "docker": "docker exec -it featherpanel_backend php cli module",
        "source_dev": "cd /var/www/featherpanel/backend && php cli module"
      }
    },
    {
      "name": "rebuild",
      "class_name": "Rebuild",
      "description": "Rebuild the database!",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/Rebuild.php",
      "invoke": {
        "production": "featherpanel rebuild",
        "docker": "docker exec -it featherpanel_backend php cli rebuild",
        "source_dev": "cd /var/www/featherpanel/backend && php cli rebuild"
      }
    },
    {
      "name": "saas",
      "class_name": "Saas",
      "description": "SaaS administrative helper for automation and scripting",
      "subcommands": [
        {
          "name": "createuser",
          "description": "Create a new user (usage: saas createuser <username> <email> <firstName> <lastName> <password> [roleId])"
        },
        {
          "name": "deleteuser",
          "description": "Delete a user (usage: saas deleteuser <uuid|username|email>)"
        },
        {
          "name": "updateuser",
          "description": "Update a user field (usage: saas updateuser <uuid|username|email> <field> <value>)"
        },
        {
          "name": "banuser",
          "description": "Ban a user (usage: saas banuser <uuid|username|email>)"
        },
        {
          "name": "unbanuser",
          "description": "Unban a user (usage: saas unbanuser <uuid|username|email>)"
        },
        {
          "name": "resetpassword",
          "description": "Reset user password (usage: saas resetpassword <uuid|username|email> <newPassword>)"
        },
        {
          "name": "userinfo",
          "description": "Get user information (usage: saas userinfo <uuid|username|email>)"
        },
        {
          "name": "listusers",
          "description": "List users (usage: saas listusers [limit] [search])"
        },
        {
          "name": "setsetting",
          "description": "Set a configuration setting (usage: saas setsetting <key> <value>)"
        },
        {
          "name": "getsetting",
          "description": "Get a configuration setting (usage: saas getsetting <key>)"
        },
        {
          "name": "listsettings",
          "description": "List all configurable settings (usage: saas listsettings)"
        }
      ],
      "source": "backend/app/Cli/Commands/Saas.php",
      "invoke": {
        "production": "featherpanel saas",
        "docker": "docker exec -it featherpanel_backend php cli saas",
        "source_dev": "cd /var/www/featherpanel/backend && php cli saas"
      }
    },
    {
      "name": "seedWebPlates",
      "class_name": "SeedWebPlates",
      "description": "Upsert bundled system WebPlate templates (static, PHP, Node, Python)",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/SeedWebPlates.php",
      "invoke": {
        "production": "featherpanel seedWebPlates",
        "docker": "docker exec -it featherpanel_backend php cli seedWebPlates",
        "source_dev": "cd /var/www/featherpanel/backend && php cli seedWebPlates"
      }
    },
    {
      "name": "settings",
      "class_name": "Settings",
      "description": "Interactive settings configuration with a beautiful UI!",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/Settings.php",
      "invoke": {
        "production": "featherpanel settings",
        "docker": "docker exec -it featherpanel_backend php cli settings",
        "source_dev": "cd /var/www/featherpanel/backend && php cli settings"
      }
    },
    {
      "name": "setup",
      "class_name": "Setup",
      "description": "Setup the database and the application!",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/Setup.php",
      "invoke": {
        "production": "featherpanel setup",
        "docker": "docker exec -it featherpanel_backend php cli setup",
        "source_dev": "cd /var/www/featherpanel/backend && php cli setup"
      }
    },
    {
      "name": "snapshots",
      "class_name": "Snapshots",
      "description": "Manage database snapshots (create, list, download, restore, delete)",
      "subcommands": [
        {
          "name": "list",
          "description": "List all available database snapshots"
        },
        {
          "name": "create",
          "description": "Create a new database snapshot"
        },
        {
          "name": "download",
          "description": "Download a snapshot file (usage: snapshots download <filename>)"
        },
        {
          "name": "restore",
          "description": "Restore database from a snapshot (usage: snapshots restore <filename> [-y])"
        },
        {
          "name": "delete",
          "description": "Delete a snapshot file (usage: snapshots delete <filename>)"
        }
      ],
      "source": "backend/app/Cli/Commands/Snapshots.php",
      "invoke": {
        "production": "featherpanel snapshots",
        "docker": "docker exec -it featherpanel_backend php cli snapshots",
        "source_dev": "cd /var/www/featherpanel/backend && php cli snapshots"
      }
    },
    {
      "name": "testAsyncRunner",
      "class_name": "TestAsyncRunner",
      "description": "Test mail sending",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/TestAsyncRunner.php",
      "invoke": {
        "production": "featherpanel testAsyncRunner",
        "docker": "docker exec -it featherpanel_backend php cli testAsyncRunner",
        "source_dev": "cd /var/www/featherpanel/backend && php cli testAsyncRunner"
      }
    },
    {
      "name": "users",
      "class_name": "Users",
      "description": "Interactive user management with a beautiful UI!",
      "subcommands": [],
      "source": "backend/app/Cli/Commands/Users.php",
      "invoke": {
        "production": "featherpanel users",
        "docker": "docker exec -it featherpanel_backend php cli users",
        "source_dev": "cd /var/www/featherpanel/backend && php cli users"
      }
    }
  ]
}