SynaLinks/synalinks-skills

What this repo does

• Provides a single “skill” – a SKILL.md file plus example scripts and reference docs – that teaches coding agents (Claude Code, Codex, OpenCode, pi, etc.) how to use the Synalinks Python library correctly.
• The skill follows the open Agent Skills format, so any agent that understands that format can automatically load it.

How you would use it

1. Install the skill with the skills CLI (a Node‑based tool):

   npx skills add SynaLinks/synalinks-skills --skill synalinks
   

   • By default it installs into the current project’s .claude/skills/ (or the equivalent folder for the agent you use).
   • You can install globally (--global) or copy instead of symlinking (--copy).
2. The agent reads the SKILL.md front‑matter, recognises the description, and auto‑activates the skill when you ask it to write Synalinks code.
3. The skill contains:
   • A scannable guide (SKILL.md) that breaks the Synalinks framework into sections (Core, Programs, Modules, Control flow, Knowledge, Training, Rewards, Optimizers, Providers, Datasets).
   • Example scripts (scripts/) with usage notes and captured run logs.
   • Deep‑dive reference docs (references/) for each section.
4. When the agent generates code, the skill’s instructions keep the output idiomatic to Synalinks, preventing it from mixing in unrelated APIs like Keras, LangChain, or DSPy.
5. Update the skill later with npx skills update (or reinstall from the lockfile for reproducible builds).

Who might find this useful

• Developers building applications with the Synalinks neuro‑symbolic AI framework who want AI‑assisted coding that respects Synalinks conventions.
• Teams using Claude Code, Codex, OpenCode, pi, or any of the 70+ supported agents and looking for a plug‑and‑play way to improve code quality.
• CI pipelines that want to ensure agents have the same skill set across environments (the repo includes CI that validates the skill file against the spec).

Limitations / things to know

• The repository only ships one skill; it does not contain the Synalinks library itself.
• The skill is not versioned – it always tracks the main branch, so you rely on the skills CLI to fetch the latest commit.
• It requires the Node.js npx environment for installation; the skill itself is just markdown and scripts, no additional runtime dependencies.
• It works only with agents that support the Agent Skills spec; unsupported agents will ignore it.

---

All information above is taken directly from the repository’s README.