agentleFS
broneqbroneq/bdk/skills/setup/SKILL.md

setup

Skill1 starsChanged 48 days agoMITView on GitHub

Initialize .bdk/settings.json for this project. Run once per project when BDK blocks session start with missing settings.

191 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use add-voice-transcription, add-discord and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • juancruzmunozalbeloSkill

    add-voice-transcription

    Add voice message transcription to NanoClaw using OpenAI's Whisper API. Automatically transcribes WhatsApp voice notes so the agent can read and respond to them.

    Also in 5 projects that use this

  • MicrosoftSkill

    add-discord

    Add Discord bot channel integration via Chat SDK.

    Also in 11 projects that use this

  • MicrosoftSkill

    add-slack

    Add Slack channel integration via Chat SDK.

    Also in 11 projects that use this

  • juancruzmunozalbeloSkill

    add-telegram-swarm

    Add Agent Swarm (Teams) support to Telegram. Each subagent gets its own bot identity in the group. Requires Telegram channel to be set up first (use /add-telegram). Triggers on "agent swarm", "agent teams telegram", "telegram swarm", "bot pool".

    Also in 7 projects that use this

  • +8 more from microsoft

The file

Show its rules and text

We split this skill into the rules it gives an agent

19 rules. 0 are common, 6 are distinctive, and 13 are very specific to this project.

  • 0

    Common

    Most of the 171 edited versions we read keep these.

  • 6

    Distinctive

    This author's own choices. Worth a look.

  • 13

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    If .bdk/settings.json already exists and --force was not passed:

    line 19
  2. Distinctive:

    Read the file and show current values

    line 20
  3. Distinctive:

    Ask user: "Settings already exist.

    line 21
  4. Distinctive:

    Read the following files if they exist and extract command/tool hints:

    line 25
  5. Very specific:

    Check devDependencies/dependencies for: vitest, jest, @playwright/test, cypress, eslint, prettier, typescript — only as fallback if no …

    line 36
  6. Very specific:

    If poetry.lock present → poetry run pytest, poetry run ruff, etc.

    line 42
  7. Very specific:

    Check for .golangci.yml or .golangci.toml → lint: golangci-lint run

    line 48
  8. Very specific:

    Check scripts for test key.

    line 64
  9. Very specific:

    Check for phpcs or pint for lint

    line 65
  10. Very specific:

    Test: bundle exec rspec (if rspec in Gemfile) or bundle exec rake test

    line 69
  11. Very specific:

    Test: flutter test (if flutter sdk) or dart test

    line 79
  12. Distinctive:

    Not sure a form exists → omit it.

    line 109
  13. Very specific:

    Use the AskUserQuestion tool with up to 4 questions in a single call:

    line 114
  14. Very specific:

    If more than 4 confirmation categories exist, prioritize: test → lint → features → build.

    line 123
  15. Distinctive:

    Create directory and file:

    line 129
  16. Very specific:

    Write settings.json with confirmed values plus the tier/scoping forms from Phase 2b:

    line 137
  17. Very specific:

    Commit .bdk/settings.json (shared with team — consistent commands for all contributors)

    line 175
  18. Very specific:

    Add to .gitignore: .bdk/plans/ and .bdk/design/ (personal artifacts)

    line 176
  19. Distinctive:

    Ask: "Add these to .gitignore now?

    line 184

“Common” is measured: kept by at least 6 in 10 of the 171 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Relies on BDK foundation (STARTUP_INSTRUCTIONS.md). Assumes environment discovery has already run (language, test runner, build tool are known).

BDK Setup

Initializes .bdk/settings.json for this project. Probes project files to detect languages, test commands, lint commands, and build commands, then confirms with the user before writing.

Workflow

Phase 1: Check existing config

If .bdk/settings.json already exists and --force was not passed:

  • Read the file and show current values
  • Ask user: "Settings already exist. Overwrite?" — if no, stop

Phase 2: Probe project files

Read the following files if they exist and extract command/tool hints:

Command resolution priority — always prefer running tools via the package manager over direct binary invocation:

  • package.json scripts → npm run <script> / yarn <script> / pnpm <script> (detect manager by lockfile: package-lock.json → npm, yarn.lock → yarn, pnpm-lock.yaml → pnpm)
  • Python with pyproject.toml → poetry run <tool> if poetry.lock exists, else direct
  • Ruby → bundle exec <tool> always
  • Direct binary only as last resort (no package manager detected)

JavaScript/TypeScript (package.json):

  • Scan scripts for keys: test, test:unit, test:e2e, test:integration, lint, lint:fix, build, typecheck, compile
  • Emit as npm run <key> (or yarn/pnpm equivalent per lockfile)
  • Check devDependencies/dependencies for: vitest, jest, @playwright/test, cypress, eslint, prettier, typescript — only as fallback if no matching script key found
  • Presence of next.config.* → add next to languages
  • Presence of react in deps → add react to languages

Python (pyproject.toml, setup.py, requirements*.txt):

  • Detect pytest, ruff, mypy, black, flake8
  • If poetry.lock present → poetry run pytest, poetry run ruff, etc.
  • Else direct: pytest, ruff, etc.
  • Language: python

Go (go.mod):

  • Test: go test ./...
  • Check for .golangci.yml or .golangci.toml → lint: golangci-lint run
  • Else lint: go vet ./...
  • Language: go

Rust (Cargo.toml):

  • Test: cargo test
  • Lint: cargo clippy
  • Build: cargo build
  • Language: rust

Java (pom.xml or build.gradle):

  • Maven: mvn test, mvn package
  • Gradle: ./gradlew test, ./gradlew build
  • Language: java

PHP (composer.json):

  • Check scripts for test key; else detect phpunit or artisan test
  • Check for phpcs or pint for lint
  • Language: php

Ruby (Gemfile):

  • Test: bundle exec rspec (if rspec in Gemfile) or bundle exec rake test
  • Lint: bundle exec rubocop
  • Language: ruby

C# (*.csproj or *.sln):

  • Test: dotnet test
  • Build: dotnet build
  • Language: csharp

Dart/Flutter (pubspec.yaml):

  • Test: flutter test (if flutter sdk) or dart test
  • Language: dart

Phase 2b: Fill in tier and scoping forms

The full command is the least useful thing about a tool entry. BDK runs scoped checks throughout a plan and the full suite exactly once, at the end — so every entry needs a tier and, wherever the tool supports it, the narrower forms. Getting these right here is what stops every later agent from guessing at npm run test:unit -- <path> versus vitest related.

Set tier on every test-tools entry (fast | e2e) and every lint-tools entry (lint | format | typecheck). Never leave it out: BDK infers a missing tier from the tool name, and an inferred fast on an e2e runner means a slow suite runs at every group boundary.

{files} is a literal placeholder in these templates — callers substitute a path list. Derive per runner:

Runnerscopedrelatedfailedincremental
vitestnpx vitest run {files}npx vitest related --run {files}npx vitest run --changed—
jestnpx jest {files}npx jest --findRelatedTests {files}npx jest --onlyFailures—
playwrightnpx playwright test {files}—npx playwright test --last-failed—
cypressnpx cypress run --spec {files}———
pytestpytest {files}—pytest --lf—
go testgo test {files}———
cargo testcargo test {files}———
rspecbundle exec rspec {files}—bundle exec rspec --only-failures—
eslintnpx eslint {files}———
prettiernpx prettier --check {files}———
ruffruff check {files}———
tsc———npx tsc -b --incremental
mypymypy {files}——mypy --incremental .

Rules for anything not in the table:

  • Package-manager script wrapping a runner that takes paths → <script> -- {files} (npm run test:unit -- {files}). The -- is required or the paths reach npm, not the runner.
  • A tool that takes no path list (most typecheckers, some build-mode linters) → omit scoped; give an incremental form if the tool has a cache flag.
  • Not sure a form exists → omit it. A wrong template is worse than a missing one: BDK falls back cleanly from a missing form, and silently runs the wrong thing with a broken one.
  • scoped and related must contain {files}; the config hook rejects settings where they do not, because such a command ignores the file list and quietly runs everything.

Phase 3: Confirm settings via AskUserQuestion

Use the AskUserQuestion tool with up to 4 questions in a single call:

  1. Test commands — multiSelect: true, options: each detected command as its own option + "None". User can add unlisted commands via "Other".
  2. Lint commands — multiSelect: true, same pattern

Confirm the full commands only. Tiers and scoped forms are derived from Phase 2b for whatever the user confirms — they are mechanical consequences of the runner, not preferences worth a question. Show them in the completion summary instead so a wrong derivation is visible. 3. Features - single select, question: "Use caveman mode (terse replies)?", options: "On" (writes "caveman": true), "Off" (writes "caveman": false). 4. Build command — only include if a build tool was detected or the language typically has one (e.g. TypeScript, Java, Rust); skip otherwise to stay under 4 questions

If more than 4 confirmation categories exist, prioritize: test → lint → features → build. Handle remaining categories with a follow-up AskUserQuestion call after writing.

"Other" is automatically appended by the UI — user can type any custom command there.

Phase 4: Write .bdk/settings.json

Create directory and file:

.bdk/
├── settings.json
├── plans/
└── design/

Write settings.json with confirmed values plus the tier/scoping forms from Phase 2b:

{
  "$schema": "https://raw.githubusercontent.com/broneq/bdk/main/hooks/check-bdk-config/settings.schema.json",
  "languages": ["typescript", "react"],
  "test-tools": [
    {
      "type": "vitest",
      "tier": "fast",
      "command": "npm run test:unit",
      "scoped": "npx vitest run {files}",
      "related": "npx vitest related --run {files}",
      "failed": "npx vitest run --changed"
    },
    {
      "type": "playwright",
      "tier": "e2e",
      "command": "npm run test:e2e",
      "scoped": "npx playwright test {files}",
      "failed": "npx playwright test --last-failed"
    }
  ],
  "lint-tools": [
    {"type": "eslint", "tier": "lint", "command": "npm run lint", "scoped": "npx eslint {files}"},
    {"type": "tsc", "tier": "typecheck", "command": "npm run typecheck", "incremental": "npx tsc -b --incremental"}
  ],
  "build-tools": [{"type": "tsc", "command": "npm run build"}],
  "features": {
    "caveman": true
  }
}

type names the runner or framework (vitest, playwright, pytest, eslint, tsc), not the package manager — BDK reads it to infer a missing tier. Omit empty arrays (e.g. no build-tools key if none detected/provided), and omit any per-entry form the tool does not support. build-tools need no tier.

Phase 5: Git guidance

Recommend:

  • Commit .bdk/settings.json (shared with team — consistent commands for all contributors)
  • Add to .gitignore: .bdk/plans/ and .bdk/design/ (personal artifacts)

Show the gitignore lines to add:

.bdk/plans/
.bdk/design/

Ask: "Add these to .gitignore now? [y/n]"

Completion

Print:

[setup] .bdk/settings.json created.
[setup] Test tiers: {tier}={command} (scoped: {scoped|none}) …
[setup] Lint tiers: {tier}={command} (scoped: {scoped|none}) …
[setup] Directories created: .bdk/plans/, .bdk/design/
[setup] Restart your Claude Code session — BDK will inject project settings on startup.

The tier lines exist so a wrong derivation is caught now, by the one person who knows the project, rather than showing up later as a slow suite running at every group boundary.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.