Skip to content

Commit d5f1049

Browse files
committed
docs: add AI agent context files (AGENTS.md, CLAUDE.md, GEMINI.md)
1 parent 082820b commit d5f1049

3 files changed

Lines changed: 67 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Kestra dbt Plugin
2+
3+
## What
4+
5+
Integrate dbt data transformations into Kestra orchestration pipelines. Exposes 13 plugin components (tasks, triggers, and/or conditions).
6+
7+
## Why
8+
9+
Enables Kestra workflows to interact with DBT, allowing orchestration of DBT-based operations as part of data pipelines and automation workflows.
10+
11+
## How
12+
13+
### Architecture
14+
15+
Single-module plugin. Source packages under `io.kestra.plugin`:
16+
17+
- `dbt`
18+
19+
### Key Plugin Classes
20+
21+
- `io.kestra.plugin.dbt.cli.Build`
22+
- `io.kestra.plugin.dbt.cli.Compile`
23+
- `io.kestra.plugin.dbt.cli.DbtCLI`
24+
- `io.kestra.plugin.dbt.cli.Deps`
25+
- `io.kestra.plugin.dbt.cli.Freshness`
26+
- `io.kestra.plugin.dbt.cli.List`
27+
- `io.kestra.plugin.dbt.cli.Run`
28+
- `io.kestra.plugin.dbt.cli.Seed`
29+
- `io.kestra.plugin.dbt.cli.Setup`
30+
- `io.kestra.plugin.dbt.cli.Snapshot`
31+
- `io.kestra.plugin.dbt.cli.Test`
32+
- `io.kestra.plugin.dbt.cloud.CheckStatus`
33+
- `io.kestra.plugin.dbt.cloud.TriggerRun`
34+
35+
### Project Structure
36+
37+
```
38+
plugin-dbt/
39+
├── src/main/java/io/kestra/plugin/dbt/models/
40+
├── src/test/java/io/kestra/plugin/dbt/models/
41+
├── build.gradle
42+
└── README.md
43+
```
44+
45+
### Important Commands
46+
47+
```bash
48+
# Build the plugin
49+
./gradlew shadowJar
50+
51+
# Run tests
52+
./gradlew test
53+
54+
# Build without tests
55+
./gradlew shadowJar -x test
56+
```
57+
58+
### Configuration
59+
60+
All tasks and triggers accept standard Kestra plugin properties. Credentials should use
61+
`{{ secret('SECRET_NAME') }}` — never hardcode real values.
62+
63+
## Agents
64+
65+
**IMPORTANT:** This is a Kestra plugin repository (prefixed by `plugin-`, `storage-`, or `secret-`). You **MUST** delegate all coding tasks to the `kestra-plugin-developer` agent. Do NOT implement code changes directly — always use this agent.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

GEMINI.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)