Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/SGizek/Raiku/llms.txt

Use this file to discover all available pages before exploring further.

raiku validate is the authoritative correctness gate for any Raiku package. It parses both raiku.toml and version.yml, runs every schema rule, checks structural requirements, enforces security constraints on the build command, and reports each finding with a severity level. A package that passes raiku validate with zero errors is guaranteed to be accepted by raiku publish. The --all flag lets maintainers validate every package in the UserSub/ tree in a single pass, making it practical to run in CI pipelines against the whole repository.

Usage

raiku validate [--dir PATH] [--all] [--language LANG] [--strict]

Flags

FlagShortDefaultDescription
--dir.Package directory to validate
--allfalseValidate all packages found under UserSub/
--language-lallWhen combined with --all, limit validation to one language
--strictfalseExit with a non-zero code if any warnings are found (not just errors)

Validation Checks

CheckSeverity
raiku.toml exists and parses without errorsError
version.yml exists and parses without errorsError
All required fields are present and have valid typesError
language is one of the eight supported valuesError
version is a valid semantic version stringError
stability_level is a recognised valueError
version in raiku.toml matches version in version.ymlError
src/ directory exists and contains at least one fileError
No forbidden file types appear in the package rootError
Build command does not contain forbidden shell patternsError
Package name matches the allowed naming patternError
README.md existsWarning
Errors block submission entirely. Warnings are reported but do not cause raiku validate to exit non-zero unless --strict is passed.

Behavior

When validating a single directory (the default), raiku validate prints a colour-coded panel showing every error and warning it found, or a green PASSED panel if the package is clean. When --all is used, it walks UserSub/<Language>/<package>/ for every supported language (or just the requested one) and renders a summary table with PASS / WARN / FAIL status for each package. Packages that fail are expanded below the table with their individual error messages.
The security check on build_command scans for shell injection patterns and known dangerous constructs. Packages with flagged build commands cannot be published to the index.

Examples

raiku validate

Exit Codes

CodeMeaning
0All checks passed (or only warnings, without --strict)
1One or more errors found, or warnings found with --strict
Add raiku validate --all --strict as a step in your GitHub Actions workflow to catch regressions before they land on the main branch.

Build docs developers (and LLMs) love