Skip to main content

Pikku CLI Error Codes

This directory contains documentation for all Pikku CLI error codes. Each error has a unique code and detailed troubleshooting guide.

Error Categories

Error codes use random 3-digit numbers to avoid implying a sequential order. Each code links to detailed documentation and troubleshooting steps.

Validation Errors

Errors related to missing required properties or invalid types in your Pikku configuration.

CodeDescriptionLink
PKU111Missing Name PropertyView
PKU123Missing Description PropertyView
PKU220Missing URI PropertyView
PKU236Missing Function PropertyView
PKU247Invalid Tags TypeView
PKU300Invalid HandlerComing soon
PKU370Missing Title PropertyView
PKU384Missing Queue NameView
PKU400Missing Channel NameView

Configuration Errors

Errors related to Pikku configuration and schema generation.

CodeDescriptionLink
PKU426Config Type Not FoundView
PKU427Config Type UndefinedComing soon
PKU431Schema Has No RootView
PKU456Schema Generation ErrorView
PKU488Schema Load ErrorComing soon

Function Errors

Errors related to Pikku function definitions and metadata.

CodeDescriptionLink
PKU559Function Metadata Not FoundView
PKU568Handler Not ResolvedComing soon

Middleware & Permission Errors

Errors related to middleware and permission configuration.

CodeDescriptionLink
PKU685Middleware Handler InvalidView
PKU715Middleware Tag InvalidComing soon
PKU736Middleware Empty ArrayComing soon
PKU787Middleware Pattern InvalidComing soon
PKU835Permission Handler InvalidView
PKU836Permission Tag InvalidComing soon
PKU937Permission Empty ArrayComing soon
PKU975Permission Pattern InvalidComing soon

How to Use This Documentation

When you encounter an error:

  1. Find the error code - Look for [PKU###] in the error message
  2. Open the corresponding guide - Click the link in the table above
  3. Follow the fix instructions - Each guide includes:
    • What went wrong
    • How to fix it
    • Common mistakes
    • Related errors

Example Error Message

[PKU236] No valid 'func' property for route '/api/users'.
→ https://pikku.dev/docs/errors/pku236

This tells you:

  • The error code is PKU236
  • The issue is a missing or invalid func property
  • The route affected is /api/users
  • Documentation is available at the provided URL

Contributing

If you encounter an error that isn't documented or have suggestions for improving these guides, please open an issue on GitHub describing the problem and include the full error message and context.