-
Notifications
You must be signed in to change notification settings - Fork 200
Add agent files to DABs templates #5996
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lennartkats-db
wants to merge
9
commits into
main
Choose a base branch
from
agent-files-in-template
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+498
−0
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
3bf1d26
Add AGENTS.md and CLAUDE.md to bundle templates
lennartkats-db 0785586
Rename Databricks Asset Bundles to Declarative Automation Bundles in …
lennartkats-db d855f4e
Shorten template AGENTS.md to point at the databricks skill
lennartkats-db 3703409
Frame template AGENTS.md around using and installing the agent skills
lennartkats-db f9e05fc
Merge remote-tracking branch 'origin/main' into agent-files-in-template
lennartkats-db c588eaa
Add AGENTS.md and CLAUDE.md to bundle templates
lennartkats-db 109d675
Add PR link to the AGENTS.md changelog fragment
lennartkats-db 2ecf715
Merge remote-tracking branch 'origin/main' into agent-files-in-template
lennartkats-db b0d8254
Regenerate pipelines template goldens for AGENTS.md and CLAUDE.md
lennartkats-db File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| Bundle templates now scaffold an `AGENTS.md` that points coding agents at Databricks AI Tools, alongside a one-line `CLAUDE.md` that includes it via `@AGENTS.md` ([#5996](https://github.com/databricks/cli/pull/5996)). |
25 changes: 25 additions & 0 deletions
25
acceptance/bundle/templates/dbt-sql/output/my_dbt_sql/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
acceptance/bundle/templates/dbt-sql/output/my_dbt_sql/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
acceptance/bundle/templates/default-minimal/output/my_default_minimal/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
acceptance/bundle/templates/default-minimal/output/my_default_minimal/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
...ance/bundle/templates/default-python/classic/output/my_default_python/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
...ance/bundle/templates/default-python/classic/output/my_default_python/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
...e/bundle/templates/default-python/serverless/output/my_default_python/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
...e/bundle/templates/default-python/serverless/output/my_default_python/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
acceptance/bundle/templates/default-scala/output/my_default_scala/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
acceptance/bundle/templates/default-scala/output/my_default_scala/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
acceptance/bundle/templates/default-sql/output/my_default_sql/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
acceptance/bundle/templates/default-sql/output/my_default_sql/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
...ndle/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
...ndle/templates/lakeflow-pipelines/python/output/my_lakeflow_pipelines/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
.../bundle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
.../bundle/templates/lakeflow-pipelines/sql/output/my_lakeflow_pipelines/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
acceptance/pipelines/e2e/output/lakeflow_project/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
acceptance/pipelines/init/python/output/my_python_project/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
acceptance/pipelines/init/python/output/my_python_project/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
25 changes: 25 additions & 0 deletions
25
acceptance/pipelines/init/sql/output/my_sql_project/AGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> |
6 changes: 6 additions & 0 deletions
6
acceptance/pipelines/init/sql/output/my_sql_project/CLAUDE.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # CLAUDE.md | ||
|
|
||
| Project guidance for AI agents lives in AGENTS.md. | ||
| Claude Code loads it via the import below. | ||
|
|
||
| @AGENTS.md |
33 changes: 33 additions & 0 deletions
33
libs/template/templates/dbt-sql/template/{{.project_name}}/AGENTS.md.tmpl
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| {{- /* | ||
| * Template for the AGENTS.md / CLAUDE.md files created in new projects. | ||
| * | ||
| * Goal for this file is to point agents to Databricks AI Tools for guidance. | ||
| * A secondary goal is to offer a placeholder to users to extend with their own instructions. | ||
| * It is a non-goal to inline all instructions. | ||
| * | ||
| */ -}} | ||
| # Declarative Automation Bundles Project | ||
|
|
||
| This project uses Declarative Automation Bundles (DABs) for deployment. Add project-specific instructions below. | ||
|
|
||
| ## For AI Agents: Use Databricks AI Tools | ||
|
|
||
| **BEFORE any other action, read the `databricks-core` skill.** | ||
|
|
||
| It sets you up to work with this project reliably: CLI authentication, profile | ||
| selection, data discovery, and the bundle deployment workflow. Without it, | ||
| results are often slower and less accurate. | ||
|
|
||
| If this skill is not available (Databricks AI Tools are not installed), you can install them for your coding agent in seconds: | ||
|
|
||
| ```bash | ||
| databricks aitools install | ||
| ``` | ||
|
|
||
| If the CLI is not installed, see: https://docs.databricks.com/dev-tools/cli/install | ||
|
|
||
| --- | ||
|
|
||
| ## Project Instructions | ||
|
|
||
| <!-- Add your project-specific instructions, coding conventions, or notes here --> | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is repeated a few times now, as a followup I want to look into a clean way to avoid the duplication. That will require a change in the templating code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The default-*/ templates already pick up everything from default/ so you only need to duplicate dbt-sql
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unfortunately, default-sql and default-scala are also special right now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Followup PR: #6017