Skip to main content

require-relative-skill-links

Require Codex skill definition files to use relative Markdown links for workspace resources.

Rule catalog ID: R018

Targeted pattern scope​

  • **/.agents/skills/**/*.md
  • Codex plugin skill directories

What this rule reports​

  • Codex skill definition files should reference workspace resources with relative Markdown links, not {{destination}}.

Why this rule exists​

Require Codex skill definition files to use relative Markdown links for workspace resources.

❌ Incorrect​

A file in the targeted scope that produces any diagnostic listed above is incorrect for this rule.

✅ Correct​

A file is correct when it uses the documented Codex structure and produces no diagnostic from this rule.

Behavior and migration notes​

Included in:

  • codex.configs.recommended
  • codex.configs.strict
  • codex.configs.all

ESLint flat config example​

The preset layers supply the correct Markdown, TOML, or JSON language configuration. Override the rule only in a later matching flat-config entry:

import codex from "@typpi/eslint-plugin-codex";

export default [
 ...codex.configs.recommended,
 {
  rules: { "codex/require-relative-skill-links": "error" },
 },
];

Further reading​