JGC-473 - Add --ai-help flag, AI text for umbrella commands, and call-site wiring#3503
Draft
ehl-jf wants to merge 2 commits into
Draft
JGC-473 - Add --ai-help flag, AI text for umbrella commands, and call-site wiring#3503ehl-jf wants to merge 2 commits into
ehl-jf wants to merge 2 commits into
Conversation
Add a global --ai-help flag that, together with the JFROG_CLI_AI_HELP env var, switches the conversion layer in jfrog-cli-core to render AIDescription instead of Description. The argv pre-pass runs before getCommands() so the conversion layer (invoked during command setup) reads the env var early; urfave/cli's own flag parsing happens later inside app.Run, by which time command strings are already frozen. The flag deliberately omits EnvVar: urfave/cli's BoolFlag EnvVar binding parses the env value with strconv.ParseBool at startup and crashes on unparseable values (e.g. JFROG_CLI_AI_HELP=maybe). Our resolver in docs/common.AIHelpEnabled treats unparseable as a soft fall-back to detection - bypassing urfave/cli's binding preserves that gentler behavior. No AIDescription content is populated yet; that arrives via the follow-up backfill commit (umbrella subagent for help.go files and call-site rewrites).
…l sites Builds on commit 0650eec (which added the --ai-help flag and argv pre-pass to main.go). This commit completes the umbrella's side of JGC-473 by: 1. Adding GetAIDescription() to 85 docs/<ns>/<cmd>/help.go files for all visible jfrog-cli local commands. 28 help.go files for hidden / deprecated / dead-code stubs were intentionally skipped. 2. Rewriting cli.Command literals in main.go and 7 */cli.go files to route Usage / HelpName through corecommon.ResolveDescription, so the conversion-layer mechanism in jfrog-cli-core applies to the umbrella's own urfave/cli-based commands (which don't go through components.Command). For namespace shells with hardcoded Usage strings (rt, mc, pl, c, etc.) new <name>AIUsage constants were introduced. 3. Adding JFROG_CLI_AI_HELP=false default in main_test.go's setupIntegrationTests so help-text assertions remain deterministic when the test runner inherits an AI agent's env (CLAUDECODE, CURSOR_AGENT, etc.). CI runners without agent env are unaffected. TEMPORARY go.mod state - REMOVE the 5 replace directives in the replace block before merge. Each points at the in-flight JGC-473 branch of the respective repo (jfrog-cli-core on JGC-473-devbase; 4 plugin repos on developer's fork because direct org push is not in scope for plugin repos). Once each repo's JGC-473 PR merges to its base branch, the require pinning is sufficient and these replaces MUST be removed. This PR MUST NOT merge until: (a) all 5 cross-repo JGC-473 PRs have merged, AND (b) the yarn-coordination break between core master and jfrog-cli-artifactory main is resolved upstream (RTECO-1035 follow-up).
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
Top-of-stack PR for JGC-473. Adds AI-agent-oriented help text to the JFrog CLI as a whole.
Two commits on this branch:
0650eecb— Add--ai-helpglobal flag + argv pre-pass. Bridges `--ai-help` to `JFROG_CLI_AI_HELP` before `getCommands()` runs, since the conversion layer in jfrog-cli-core reads the env var during command setup (urfave/cli's own flag parser runs too late).dfde4c12— PopulateGetAIDescription()in 85docs/<ns>/<cmd>/help.gofiles for all visible umbrella-local commands (28 hidden/dead-code stubs skipped). Rewrite ~85cli.Commandliterals inmain.go+ 7*/cli.gofiles to routeUsage/HelpNamethroughcorecommon.ResolveDescription(umbrella uses urfave/cli directly, notcomponents.Command, so the core conversion-layer mechanism doesn't reach these — call-site rewrites are necessary). For namespace shells with hard-codedUsagestrings (rt, mc, pl, c, etc.) new<name>AIUsageconsts were introduced. AddsJFROG_CLI_AI_HELP=falsetosetupIntegrationTestsso help-text-asserting tests are deterministic when the runner inherits an AI agent's env (CLAUDECODE, CURSOR_AGENT, etc.).This PR is blocked on:
yarn.IsVersionSupportedandIsInstalledYarnVersionSupported, butjfrog-cli-artifactory/artifactory/commands/yarn/yarn.gostill calls them. A fix in jfrog-cli-artifactory is needed before this umbrella can build against merged-core-master without temporaryreplacedirectives.TEMPORARY go.mod replaces — MUST BE REMOVED BEFORE MERGE
go.modcontains 5replacedirectives pointing at the in-flight JGC-473 branches:The core entry points at `JGC-473-devbase` (a coordination branch); the other 4 point at the developer's fork (because direct org push permissions are not in scope for the plugin repos). Once each linked PR merges and the yarn coordination is resolved, replaces must be dropped and each
requirere-pinned to the merged base-branch pseudo-version.Test plan
go build ./...cleango test ./...0 failures, 15 OK packages (with the test-setup env force-off)--ai-helpflag, namespace listing, unparseable env value (graceful fallback), runtime unaffectedjf rt upload --help,jf audit --help,jf evd create --help,jf apptrust ping --help,jf worker deploy --helpall produce AI-mode output when JFROG_CLI_AI_HELP=trueOut of scope (deferred to follow-ups)
CreateUsage'sName:\n\t<cmd> - <text>format is functional but awkward. DefiningaiCommandHelpTemplate/aiAppHelpTemplatethat surfaceDescriptionas a standalone section is plan §3.2 — deferred.apptrust version-rollback: declares 2 Arguments but Action requires 3 (from-stageundocumented) — pre-existing bug, separate fix.