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 lint is an advisory quality checker that goes beyond the hard schema rules enforced by raiku validate. Where raiku validate answers the question “is this package structurally correct?”, raiku lint answers “is this package well-written?”. It inspects raiku.toml, version.yml, and README.md for common problems such as placeholder build commands, overly generic names, missing descriptions or licenses, suspicious version/stability combinations, and thin README content. Lint issues are separated into three levels — error, warning, and info — and printed in a structured table so you can address them in priority order.

Usage

raiku lint [--dir PATH] [--strict]

Flags

FlagDefaultDescription
--dir.Package directory to lint (defaults to current directory)
--strictfalseExit with a non-zero code if any warnings are found

Lint Rules

raiku.toml Checks

LevelFieldRule
WarningnameName is too generic (e.g. utils, lib, core, helpers)
WarningdescriptionNo description provided
InfodescriptionDescription is very short (under 15 characters)
WarninglicenseNo SPDX license identifier provided
InfotagsNo tags defined
Warningbuild_commandBuild command looks like a placeholder (echo hello, make, true, :)
WarninghomepageHomepage URL uses HTTP instead of HTTPS
InfohomepageNo homepage or repository URL

version.yml Checks

LevelFieldRule
Warningstability_levelVersion is pre-1.0 but stability_level is stable
InfochangelogChangelog only contains a generic initial entry
WarningchangelogChangelog is empty

README.md Checks

LevelFieldRule
ErrorREADME.mdFile is missing entirely
WarningREADME.mdContent is under 50 characters
InfoREADME.mdNo raiku install command found in the README

Lint vs. Validate

Aspectraiku lintraiku validate
PurposeStyle and best practicesSchema and structural correctness
Blocks publish?No (unless --strict)Yes
Severity levelsError, Warning, InfoError, Warning
Runs in CI?Optional but recommendedRequired
A package can pass raiku validate and still have lint issues. Always run raiku lint before opening a PR to ensure your package meets community quality standards.

Examples

raiku lint

Sample Output

When lint issues are found, raiku lint prints a table like this:
 Level    Field            Message
 ──────── ──────────────── ──────────────────────────────────────────────────────────
 warning  description      No description provided. Add a short description to ...
 warning  license          No license specified. Add an SPDX identifier (MIT, ...).
 info     tags             No tags defined. Tags help users find your package via ...
 info     homepage         No homepage or repository URL. Consider linking to ...
 info     changelog        Changelog only has a generic initial entry. Keep it ...

  0 error(s)  3 warning(s)  2 info
When no issues are found, a green panel confirms the clean result:
╭──────────────────────────────────╮
│  ✓ No lint issues found.         │
╰──────────────────────────────────╯
Use raiku lint --strict in CI together with raiku validate --strict to enforce both structural correctness and quality standards on every pull request.

Build docs developers (and LLMs) love