Metadata-Version: 2.4
Name: vulcan-skills
Version: 0.1.0
Summary: AI agent skills for the Vulcan data platform
Author-email: TMDC <team@tmdc.io>
License: Apache-2.0
Project-URL: Homepage, https://github.com/tmdc-io/vulcan-skills
Project-URL: Documentation, https://tmdc-io.github.io/vulcan-book/
Project-URL: Repository, https://github.com/tmdc-io/vulcan-skills
Keywords: vulcan,dataops,ai,agents,skills,data-engineering
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: click>=8.0
Requires-Dist: pyyaml>=6.0

# vulcan-skills

AI agent skills for the [Vulcan](https://tmdc-io.github.io/vulcan-book/) data platform.

Teach any AI agent (Cursor, Claude, GitHub Copilot) how to work with Vulcan correctly — writing models, using the CLI, following best practices.

---

## Install

```bash
pip install vulcan-skills
```

---

## Usage

### Install a skill into your project

```bash
vulcan skills install data-quality
vulcan skills install cli-commands sql-models incremental-patterns
```

Skills land as markdown files in `.vulcan/skills/` — your AI agent reads them automatically.

### List available skills

```bash
vulcan skills list
```

### See what's active in your project

```bash
vulcan skills show
```

### Add your own business rules

```bash
vulcan skills create acme-naming-rules
# Opens editor — write your rules in markdown
# Commit .vulcan/skills/acme-naming-rules.md to share with your team
```

### Remove a skill

```bash
vulcan skills remove data-quality
```

### Update installed skills

```bash
vulcan skills update
```

---

## Available Skills

| Skill | What It Teaches |
|---|---|
| `cli-commands` | All Vulcan CLI commands with examples |
| `sql-models` | How to write SQL models in Vulcan |
| `python-models` | How to write Python models |
| `incremental-patterns` | Incremental model patterns and best practices |
| `data-quality` | Writing checks, audits, and tests |
| `model-properties` | Model properties and configuration |
| `semantics` | How to define semantic layers |
| `macros` | Writing and using Jinja macros |
| `bigquery` | BigQuery-specific patterns |
| `snowflake` | Snowflake-specific patterns |
| `databricks` | Databricks-specific patterns |

---

## Project Structure After Install

```
your-vulcan-project/
├── models/
├── checks/
├── vulcan.yaml
└── .vulcan/
    └── skills/
        ├── data-quality.md          ← public skill (from this package)
        ├── incremental-patterns.md  ← public skill (from this package)
        └── acme-naming-rules.md     ← your custom skill (stays in your repo)
```

---

## Agent Setup

### Cursor

Add to your `.cursorrules`:

```
Before helping with any Vulcan task, read all files in .vulcan/skills/
```

### Claude (MCP)

Vulcan's MCP server exposes `.vulcan/skills/` to Claude automatically.

### Any other agent

Point your agent's context to read `.vulcan/skills/*.md` before every Vulcan-related task.

---

## Contributing

Skills live in `skills/` as plain markdown files. To contribute:

1. Fork this repo
2. Add or improve a skill in `skills/`
3. Open a pull request

See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

---

## License

Apache 2.0
