AI Assistants

Give AI coding assistants accurate context about installing and customizing Jolocky items.

AI coding assistants such as Claude Code and Cursor work better with Jolocky when they know how items are installed and organized. A short rules file in your project gives them that context.

For example, you can ask your assistant to:

  • "Install the Jolocky Aurora Drift footer and replace the default links with ours."
  • "Change the colors of the Jolocky footer to match our brand palette."
  • "Self-host the font used by the Jolocky footer instead of loading it from Google Fonts."

Add a Rules File

Add the following to CLAUDE.md, AGENTS.md, a Cursor rule, or your assistant's project instructions:

# Jolocky
 
- Jolocky items are installed with the shadcn CLI. Always use https://www.jolocky.com (with www).
- Free item: npx shadcn@latest add https://www.jolocky.com/r/<item>.json
- Pro item: npx shadcn@latest add @jolocky/<item>
  (requires the @jolocky registry in components.json and JOLOCKY_LICENSE_KEY in .env.local)
- Never print, log, or commit the value of JOLOCKY_LICENSE_KEY.
- Items install into components/footers/<item>/ and import their own files with relative paths. Keep that structure.
- Each footer has its own scoped CSS in footer-styles.ts or styles/. Change colors and fonts there, not in the global stylesheet.
- Content and links are props; see the item's types.ts.

Raw Markdown Docs

Every page of these docs is also available as plain Markdown, which is easier for assistants to read. Add .md to the page URL, for example:

https://www.jolocky.com/docs/cli.md

You can paste these URLs into your assistant or let it fetch them when it needs details.