Skip to content
← Public packages

@kody/trello

Read and update Trello boards, lists, cards, and comments with dry-run mutations.

FollowFork

Files

AGENTS.md

88 lines · 2.7 KB · Markdown

@kody/trello — agent notes

Human setup and intent live in README.md. This file is for agents: imports, smoke/dryRun execute snippets, and edge cases. Secrets by name only — never paste key or token values. Do not disable or enable live jobs unless the operator asks — the bundled account-health job stays enabled: false unless they turn it on after a fork.

Auth

LaneCredential
API key + tokentrelloApiKey + trelloToken (or *-<purpose>)
OAuthintegration trello / trello-<purpose>

Host: api.trello.com. Multi-account: account: 'work' → trello-work / trelloApiKey-work + trelloToken-work, or pass integrationName / secretName / apiKeySecretName / auth: 'keyToken'|'oauth' explicitly.

Import paths

ExportImport
root dispatcher (default smoke-test)kody:@kody/trello
accountskody:@kody/trello/accounts
viewerkody:@kody/trello/viewer
boardskody:@kody/trello/boards
listskody:@kody/trello/lists
cardskody:@kody/trello/cards
commentskody:@kody/trello/comments
requestkody:@kody/trello/request
smoke-testkody:@kody/trello/smoke-test
scheduled-account-healthkody:@kody/trello/scheduled-account-health
typeskody:@kody/trello/types

Prefer static kody:@kody/trello/... imports from execute. Do not lead with packages.invoke.

Smoke test (read-only)

import smokeTest from 'kody:@kody/trello/smoke-test'

export default async function main() {
	return await smokeTest()
	// Without credentials: dry-run self-check + setup URLs
	// With key/token or OAuth: live member + boards sample — no writes
}

Equivalent via root dispatcher:

import trello from 'kody:@kody/trello'

export default async function main() {
	return await trello({ action: 'smoke-test' })
}

dryRun / confirm

Pass dryRun: true on writes to return { dryRun: true, method, path, body } without contacting Trello. Live writes throw unless confirm: true.

import { createCard } from 'kody:@kody/trello/cards'

export default async function main() {
	return await createCard({
		listId: 'list-id-from-caller',
		name: 'Write the release notes',
		dryRun: true,
	})
}

Edge cases

  • Board ids, list ids, and card ids come from the call. This package has no default board.
  • Prefer Lane A (API key + token). Lane B OAuth 2 is not generally available from Atlassian yet; only use a saved trello integration when one already exists.
  • Do not enable the account-health job on the official listing; after a fork, enable only if the operator wants the weekly read.
  • Keep LICENSE (MIT), ## Intent, and community-icon.svg for community listing.