BoomTick CLI — agentic dev-tools for GitHub + AI workflows
Project description
dev-tools
Developer tooling for the BoomTick repository. The primary entry point is
td-cli, but agents should always call boomtick-mcp Tier 1 tools first —
td-cli is the Tier 2 fallback. See .agents/AGENTS.md for the full
tool hierarchy.
🚀 One-Step Setup
./setup-agent.sh
This script (symlinked to dev-tools/setup-agent.sh) handles system tools,
Node.js, pnpm, Python dependencies, Playwright, remote origin configuration,
and git hook registration.
🔑 Environment Variables
| Variable | Required | Purpose |
|---|---|---|
GITHUB_TOKEN (string) |
Required | Auth for gh and td-cli gh ... commands (PR audits, comments, variables, status checks). Standard for GH Actions. |
GH_TOKEN (string) |
Optional fallback | Legacy authentication variable, deprecated in favor of GITHUB_TOKEN. |
GITHUB_REPOSITORY (owner/repo) |
Recommended | Ensures deterministic origin remote auto-configuration. |
JULES_API_KEY |
Optional | Enables td-cli agent ... / td-cli jules ... cloud workflows. |
GEMINI_API_KEY |
Optional | Enables Gemini-backed review/audit workflows. |
Secret handling guidance
- GitHub Actions / agent runners: store
GITHUB_TOKEN,JULES_API_KEY, andGEMINI_API_KEYin repository or org Secrets. - Dev containers / local shells: export secrets before running setup/CLI:
export GITHUB_TOKEN="<token>"
export GITHUB_REPOSITORY="owner/repo"
# optional
export JULES_API_KEY="<key>"
export GEMINI_API_KEY="<key>"
Optional tuning variables
SKIP_GIT_HOOKS=1— skip git hook execution (e.g. in CI).SKIP_VALIDATION=1— skip post-setup runtime validation.NODE_MAJOR— override Node major used for apt installation (defaults to24).
🧩 Workflow-Specific Setup
After ./dev-tools/setup-agent.sh, use the following workflow-specific setup:
1) Standard PR / Review Workflows
- Plan a review (fetches context and audits):
td-cli agent plan-review --pr <PR_NUMBER>
- Submit audit results (after authoring the review in
pr-review-<PR>.md):td-cli gh audit-pr <PR_NUMBER> --submit --execute
- Pre-submit quality gate before push/merge:
td-cli gh pre-submit
2) Jules Workflows
- Required secret:
JULES_API_KEY. - Optional context env var:
JULES_SOURCE_ID(if your environment already knows the source mapping). - Typical commands:
td-cli agent dispatch <BRANCH> "<TASK>"td-cli agent fix-ci --pr-number <PR> --executetd-cli agent sync
3) Headless / Bot Auditing
- For batch auditing open PRs:
td-cli gh audit-pr <PR_NUMBER> --fetch --audit --submit --execute
- Ensure
jq,gh, Python deps, and pnpm deps are installed (handled by setup script).
🗂️ Agent Context Index
.agent-context.json (repository root) is the pre-built index that
boomtick-mcp reads on every tool call. It contains file_tree, cli_schema,
and package_json metadata — built by boomtick-pkg/scripts/build-repo-context.py.
The index is kept fresh automatically by the git hooks registered during
./setup-agent.sh:
.githooks/post-checkout— refreshes on branch switch.githooks/post-merge— refreshes on pull/merge
To manually refresh:
pnpm run agent:prime
If the index is stale, MCP tools fall back to raw filesystem calls, bypassing the index and increasing token usage. Always refresh before running reviews or dispatching Jules sessions.
🤖 Agent / Jules GitHub Command Pattern
Always use boomtick-mcp Tier 1 tools first. td-cli is the fallback
when MCP is unavailable — not the default. See .agents/AGENTS.md for the
full tool mapping table.
When td-cli must be called directly, read the CLI schema from
.agent-context.json rather than guessing flags or running --help:
# Extract schema for a specific subcommand before calling it
cat .agent-context.json | python3 -c "
import json, sys
schema = json.load(sys.stdin)
print(json.dumps(schema['cli_schema']['subcommands']['gh pr-diff'], indent=2))
"
Prefer repository CLI commands over raw gh:
# ✅ Preferred
td-cli gh <repo-command>
# ⚠️ Only if td-cli does not expose the operation
gh <command>
If auth fails, do not run gh auth login. Instead, set an environment secret
named GITHUB_TOKEN.
✅ Verification Commands (Post-Setup)
node --version # should match .node-version
pnpm --version # should be 10.28.2
td-cli doctor
pnpm run check:runtime-files
gh auth status
🆘 Troubleshooting
GitHub CLI not authenticated
gh issue create --title "<title>" --body "<details>"
If auth fails, report this exact issue (do not run interactive auth):
GitHub CLI is not authenticated. Please add an environment secret named
GITHUB_TOKENwith a repo-scoped GitHub token.
.agent-context.json stale or missing
pnpm run agent:prime
Then re-read before proceeding with any agent operation.
pnpm / Node mismatch
Stop and report the mismatch. Do not attempt to change runtime versions unless explicitly instructed to update the runtime contract.
🚀 Repository CLI (td-cli)
dev-tools/td-cli is the Tier 2 unified entry point for local repository
automation. All available subcommands and flags are defined in
dev-tools/cli-schema.json (also embedded in .agent-context.json under
cli_schema). That file is the single source of truth — never use --help
to discover flags.
Key subcommand groups:
| Group | Description |
|---|---|
doctor |
Runtime consistency check |
gh |
GitHub operations (PRs, issues, audits, conflicts) |
repo |
Repository operations (CI logs, Playwright) |
agent / jules |
Jules agent session management |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file boomtick_cli-0.2.2.tar.gz.
File metadata
- Download URL: boomtick_cli-0.2.2.tar.gz
- Upload date:
- Size: 156.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c494ee7bd865a6643e4c5f0c94110d5b3458089053bb69696f5f46cd10ef7a9d
|
|
| MD5 |
cc2c4e4700e1d03a9630530d3f7093dc
|
|
| BLAKE2b-256 |
136b241a966aa578ef784523fe35a41ad496b39e0717b3b1d052c7ccb817dd31
|
File details
Details for the file boomtick_cli-0.2.2-py3-none-any.whl.
File metadata
- Download URL: boomtick_cli-0.2.2-py3-none-any.whl
- Upload date:
- Size: 182.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e00991d6b18390043ff1f340b1f51d827ebd4f6afbe898a3bb3f401ce2a9905a
|
|
| MD5 |
9f4d41e81441234c302311dad7f37c29
|
|
| BLAKE2b-256 |
f4449a2639c0bb61f9b31d6c2fc832d64d2c1d705bf38ee1bfac83ce3858d5ee
|