Files
2026-04-14 14:10:50 +00:00

1.6 KiB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Overview

This is a CartSnitch skills repository. Skills are reusable tools that extend Claude Code's capabilities. Each skill lives in its own top-level directory.

Skill Structure

Each skill follows this convention:

  • <skill-name>/SKILL.md — Required. Contains YAML frontmatter (name, description) and usage documentation. This is the entry point Claude Code reads when invoking the skill.
  • <skill-name>/scripts/ — Optional. Implementation scripts (bash). Scripts use set -euo pipefail and the die() pattern for error handling.
  • <skill-name>/references/ — Optional. Supporting reference docs.

Current Skills

  • deal-lookup — Stub skill for looking up grocery deals. Placeholder implementation awaiting real data source integration.

Key Patterns

  • Skills are self-contained bash/markdown — no CI/CD, no package.json, no build tooling.
  • Scripts use set -euo pipefail and the die() function for error handling.
  • No centralized build, test, or lint system.

Contributing

To add a new skill:

  1. Create a <skill-name>/ directory at the root.
  2. Add <skill-name>/SKILL.md with YAML frontmatter (name, description) and documentation.
  3. Optionally add <skill-name>/scripts/ for bash implementation.
  4. Submit a PR following the standard SDLC workflow.

Importing into CartSnitch

Company skills are imported by authorized managers via the Paperclip company skills API. Once imported, skills can be assigned to agents for use in their agent configuration.