feat(cli): harden CLI ergonomics for agent use#8
Open
jbohnevail wants to merge 2 commits into
Open
Conversation
- Gate the dry-run banner on TTY so piped `--dry-run` output is pure JSON - Correct inaccurate `--json` flag descriptions across all commands - Add `--yes` flag + interactive confirmation prompt to destructive delete/remove commands (prompts only in a TTY; non-interactive runs proceed unchanged) - Enrich missing-argument errors with a copy-pasteable example invocation - Document retry/idempotency caveats in AGENTS.md
Remove the stale freeclimb-cli fork workflow note ("never PR against
FreeClimbAPI; push to work fork") and document the freeclimb-plugin
origin/PR workflow.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Agent-friendliness hardening for the FreeClimb CLI, addressing four findings from a CLI-for-agents audit:
DRY RUN - No API call will be madebanner is now gated onisTTY(), so--dry-runoutput is parseable JSON in pipelines/agents.--jsonhelp — removed the false "auto-enabled when stdout is not a TTY" claim from all command flag descriptions (behavior never did this).applications:delete,incoming-numbers:delete,recordings:delete, andconference-participants:removenow accept--yes/-yand prompt for confirmation in an interactive terminal. Non-interactive/agent runs proceed unchanged (no hang, backward compatible).bin/run.AGENTS.md(incl. that the CLI auto-retries 429/5xx/network up to 3x for all methods, so POST retries can duplicate).Test plan
tsc -bcleangeneration/dir) by reproducing on a clean stashed baseline--dry-runis pure JSON; missing-args prints an Example;describe/--helpreflect new descriptionsNotes
generation/directory that is not present in this working tree, so edits were applied to the generated.tsfiles directly. If the generator is restored, port these into its templates.