Add AI-agent help text to platform-services commands#58
Merged
Conversation
4 tasks
| AIDescription: `Fetch the recent execution history of a deployed worker. Each entry includes start/end times, status, who triggered it, the executed version, and a trace ID for cross-referencing platform logs. | ||
|
|
||
| When to use: | ||
| - Investigating why a scheduled or event-driven worker failed. |
There was a problem hiding this comment.
nit: also valid HTTP Triggered Workers
|
|
||
| Gotchas: | ||
| - The command refuses to run if manifest.action is not SCHEDULED_EVENT. | ||
| - Cron expressions must have exactly 5 fields (minute hour day month dow); 6-field (with seconds) expressions are rejected. |
There was a problem hiding this comment.
Suggested change
| - Cron expressions must have exactly 5 fields (minute hour day month dow); 6-field (with seconds) expressions are rejected. | |
| - Cron expressions must have exactly 5 fields (minute hour day month dow); 6-field (with seconds) or less than 5 digits expressions are rejected. |
| AIDescription: `List the action / event types supported by the target server. Use this to discover the valid 'action' values for 'jf worker init' and 'jf worker list'. | ||
|
|
||
| When to use: | ||
| - Looking up the exact name of an action (e.g. BEFORE_UPLOAD, GENERIC_EVENT, SCHEDULED_EVENT) before scaffolding a worker. |
There was a problem hiding this comment.
Does it return also the types definitions ? If so could be worth mentionning it in this description.
christophermiJfrog
approved these changes
May 22, 2026
ehl-jf
force-pushed
the
JGC-473-ai-context-help
branch
from
07c901b to
77979b3
Compare
Contributor
4 tasks
Populate components.Command.AIDescription on commands. The new field (added in jfrog-cli-core JGC-473) makes the conversion layer render agent-oriented text when JFROG_CLI_AI_HELP is truthy or an AI agent is auto-detected. Empty AIDescription falls back to Description, so command output is unchanged in human mode. Scope: 10 worker commands (commands/*_cmd.go) + 1 namespace in cli/cli.go with AIDescription added inline. TEMPORARY go.mod pin: the require for github.com/jfrog/jfrog-cli-core/v2 points at JGC-473-devbase (commit d507b5c6) - a coordination branch that cherry-picks JGC-473 onto core's pinned commit 908527b4 (the last commit before core master removed yarn.IsVersionSupported and IsInstalledYarnVersionSupported, which downstream callers in jfrog-cli-artifactory still depend on). This require MUST be updated to the merged master commit's pseudo-version after the jfrog-cli-core JGC-473 PR merges. Do not merge this PR until the require is re-pinned.
ehl-jf
force-pushed
the
JGC-473-ai-context-help
branch
from
77979b3 to
9cc43c1
Compare
Addresses review comments from @christophermiJfrog: - edit-schedule: clarify cron validation gotcha (6-field with-seconds and under-5-field expressions are both rejected). - execution-history: include HTTP-triggered workers in the "when to use" guidance. - list-event: note that --format json also returns each action's TypeScript type definitions. Also runs gofumpt across cli/ and commands/ to fix the Static-Check failure (struct-field alignment in the AIDescription literals).
ehl-jf
changed the title
Collaborator
Author
|
Thanks @christophermiJfrog — addressed all three in aeb8b92:
Also ran gofumpt across |
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
2 participants
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
Adds AI-agent-oriented help text (
AIDescription) so commands render richer help whenJFROG_CLI_AI_HELPis truthy or an AI agent is auto-detected. EmptyAIDescriptionfalls back toDescription; human-mode output is unchanged.Scope: 10 worker
components.Commandliterals + 1 namespace, inline in commands/*.go and cli/cli.go.Dependency on jfrog-cli-core
jfrog-cli-core's JGC-473 PR (#1563) has MERGED. This PR'sgo.modnow requires the merged core master pseudo-versionv2.60.1-0.20260601130310-8d52a530da18directly — no temporaryreplacedirective. Ready to merge on its own.Linked