Initial structure: add CLAUDE.md, LICENSE, README.md, and deal-lookup skill

Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
Paperclip
2026-04-14 14:10:50 +00:00
commit 4fc8c0014d
4 changed files with 109 additions and 0 deletions
+36
View File
@@ -0,0 +1,36 @@
# 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.
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024 CartSnitch
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+33
View File
@@ -0,0 +1,33 @@
# CartSnitch Skills
This repository contains reusable skills for CartSnitch agents. Skills extend Claude Code's capabilities with domain-specific knowledge and tooling.
## What is a Skill?
A skill is a self-contained module that provides:
- Documentation on when and how to use it
- Optional bash scripts for implementation
- Reference materials for context
## Skills
| Skill | Description |
|-------|-------------|
| `deal-lookup` | Looks up grocery deals and promotions |
## Creating a Skill
1. Create a directory: `<skill-name>/`
2. Add `SKILL.md` with YAML frontmatter:
```yaml
---
name: <skill-name>
description: One-line description of what the skill does
---
```
3. Follow with usage documentation.
4. Optionally add `scripts/` for bash implementation or `references/` for supporting docs.
## Contributing
Submit skills via pull request following the CartSnitch SDLC workflow. Once merged, authorized managers can import skills into the company skill library via the Paperclip API.
+19
View File
@@ -0,0 +1,19 @@
---
name: deal-lookup
description: Look up grocery deals and promotions from the CartSnitch deal database
---
# Deal Lookup Skill
This skill provides agents with the ability to search for grocery deals and promotions.
## Usage
When asked to find deals, discounts, or promotions for grocery items, use this skill to query the deal database.
## Placeholder
This is a stub implementation. Real integration requires:
- Connection to the CartSnitch deal data source
- Query interface for searching current promotions
- Response formatting for deal results