Configure custom recurring reports. User defines data sources, skill handles scheduling and formatting.
---
name: Report
slug: report
version: 1.0.3
description: Configure custom recurring reports. User defines data sources, skill handles scheduling and formatting.
changelog: Fixed path consistency, declared optional env vars in metadata
metadata: {"clawdbot":{"emoji":"๐","requires":{"bins":[],"env":{"optional":["USER_PROVIDED_API_KEYS"]}},"os":["linux","darwin","win32"]}}
---
## Data Storage
```
~/report/
โโโ memory.md # Index + preferences
โโโ {name}/
โ โโโ config.md # Report configuration
โ โโโ data.jsonl # Historical data
โ โโโ generated/ # Past reports
```
Create on first use: `mkdir -p ~/report`
## Scope
This skill:
- โ
Stores report configurations in ~/report/
- โ
Generates reports on schedule
- โ
Delivers via channels user configures
**User-driven model:**
- User defines WHAT data to include
- User grants access to any needed sources
- User provides API keys if external data needed
- Skill handles SCHEDULING and FORMATTING
This skill does NOT:
- โ Access APIs without user-provided credentials
- โ Pull data from sources user hasn't specified
- โ Store credentials (user provides via environment)
## Environment Variables
**No fixed requirements.** User provides API keys as needed:
```bash
# Example: if user wants Stripe data
export STRIPE_API_KEY="sk_..."
# Example: if user wants GitHub data
export GITHUB_TOKEN="ghp_..."
```
Config references env var name, never the value.
## Delivery Security
External delivery (Telegram/webhook/email) sends report content off-device.
- User explicitly configures each channel
- User responsible for trusting destination
- `file` delivery stays local (~/report/{name}/generated/)
## Quick Reference
| Task | File |
|------|------|
| Configuration schema | `schema.md` |
| Output formats | `formats.md` |
| Delivery options | `delivery.md` |
## Core Rules
### 1. User Defines Data Sources
When creating a report:
1. User specifies what data to track
2. If external API needed, user provides credentials
3. Credentials stored as env var references, not values
Example:
```
User: "Weekly report on my Stripe revenue"
Agent: "I'll need Stripe API access. Please set
STRIPE_API_KEY in your environment."
User: "Done"
โ Config stored with "source": {"type": "api", "env": "STRIPE_API_KEY"}
```
### 2. Report Configuration
In ~/report/{name}/config.md:
```yaml
name: weekly-revenue
schedule: "0 9 * * 1" # Monday 9am
sources:
- type: api
env: STRIPE_API_KEY # User provides
format: chat
delivery: telegram
```
### 3. Scheduling
| Frequency | Cron | Example |
|-----------|------|---------|
| Daily | `0 9 * * *` | 9am daily |
| Weekly | `0 9 * * 1` | Monday 9am |
| Monthly | `0 9 1 * *` | 1st of month |
| On-demand | - | When user asks |
### 4. Delivery Channels
User configures in config.md:
- `chat` โ Reply in conversation
- `telegram` โ Send to Telegram (user provides chat ID)
- `file` โ Save to ~/report/{name}/generated/
- `email` โ Send via user's configured mail
### 5. Managing Reports
```
"List my reports" โ Read ~/report/memory.md
"Pause X report" โ Update config
"Run X now" โ Generate on-demand
```
don't have the plugin yet? install it then click "run inline in claude" again.