API reference
Tools API
Project-board sync and the GitHub comment bridge.
24 modules, 190 documented exports. Version next. All packages.
packages/tools/api-coverage
packages/tools/dev
- alertalerts for the owner and the agent when a build, deploy, test run or agent run fails. Exports: DOCS_WORKFLOW, LABELS, MAIN_SCHEDULE_KEY, MAIN_SCHEDULE_NOTE, OWNER, REPO, SEVERITIES, TAIL_CHARS, ...
- benchmarkcold start time and peak memory of the commands people run, compared with packages/tools/dev/budgets.json. Exports: BUDGETS_FILE, CHECKS, REQUIREMENTS_PAGE, SNAPSHOT_FILE, compareBudgets, main, measureAll, measureCli, ...
- build-on-readybuild and tag a lane the moment a capability lands. Exports: CONFIG_PATH, EMPTY_TREE, baselineTagName, classifyCommit, execCommand, failureExcerpt, fillArgs, formatResult, ...
- delivery-reportwhat each team delivered, per day, read from git: commits per lane (by the paths a lane owns), lane tags (`<lane>/build-YYYY-MM-DD-HHMM[-N]`, `design/pack-...`, older `<lane>/build-DATE`) and release tags (`v*`). Exports: LANE_PATHS, LANES, buildReport, laneOf, reportFromGit
- ship-planthe Daily Ship Plan: the delivery plan (every lane ships daily Mon-Fri; docs/DELIVERY-PLAN.md has the cadence, owner, gate and rollback per lane) shown side by side with what packages/tools/dev/delivery-report.mjs rea... Exports: ON_HOLD, formatShipPlan, isWorkingDay, planFromReport, shipPlan
packages/tools/github-comment-bridge/src
- claudeRunnerExports: buildPrompt, runClaude
- configConfiguration is read entirely from environment variables. Exports: loadConfig
- githubGitHub REST client — a thin wrapper over @octokit/rest (the official GitHub SDK, ): Octokit owns the HTTP/auth/pagination/rate-limit/retry mechanics, this module only decides *what* to call and returns plain data (nev... Exports: createGitHubClient
- jsonStoreExports: createJsonStore
- pollerExports: establishBaseline, excerpt, extractIssueNumber, pollOnce, resolveBotLogin, summarizeRun
- triggerThe one supported trigger convention (see README): a comment whose FIRST LINE is exactly "/claude <instruction text>" (case-sensitive, must start the comment). Exports: parseTrigger
packages/tools/media
- libShared, model-free pieces of the media tools: the caption script (data model), subtitles, the clip cache key and the write guard. Exports: CLIP_CACHE, MUSIC_EXT, REPO, SLUG_RE, VIDEO_DIR, assertWritable, clipKey, feedbackOverrides, ...
- synthText to speech for the caption script, with a per-line clip cache (only edited lines are generated again), and the mix of the clips into one narration track. Exports: FFMPEG, MEDIA_CACHE, addAudio, breathSnippet, clipFile, cloneParams, duration, kokoroVoices, ...
packages/tools/paperclip
- applyPaperclip setup as code: reads company.json and makes the local Paperclip match it. Exports: parseArgs, run
- backlogFiles a backlog (backlog/<name>.json) into the Line company as Paperclip tasks. Exports: parseArgs, run
- github-syncOne-way, deterministic bridge: GitHub issues -> Paperclip issues. Exports: laneFor, mirrorBody, mirrorTitle, parseArgs, run
- libShared helpers for apply.mjs and github-sync.mjs (Paperclip setup as code). Exports: DEFAULT_API, DEFAULT_REPO_ROOT_POLICY, HERE, REDACTED, REPO_ROOT_POLICIES, asList, assertApiBase, assertRepoRoot, ...
- mock-paperclipA small in-memory stand-in for the Paperclip API, used only by the tests (ports 49600-49649). Exports: PORT_FIRST, PORT_LAST, startMock
- releasesKeeps a "Line: releases & milestones" page inside Paperclip: past, current and next milestones and releases, with due dates, progress and a forecast ETA. Exports: eta
- routinesApplies company.json "routines" to Paperclip: native recurring work that materializes auditable execution tasks. Exports: parseArgs, routineBody, run