-
Notifications
You must be signed in to change notification settings - Fork 8
Description
Description
As a new user following the documentation, I noticed an inconsistency in the CLI experience when monitoring resources.
Current Behavior
All example READMEs recommend using kubectl get tasks -w to watch task progress:
examples/README.md:kubectl get tasks -wexamples/01-simple-task/README.md:kubectl get tasks -wexamples/02-task-with-workspace/README.md:kubectl get tasks -wexamples/03-taskspawner-github-issues/README.md:kubectl get tasks -wexamples/04-taskspawner-cron/README.md:kubectl get tasks -wself-development/README.md:kubectl get tasks -w
However, the main README promotes the axon CLI as the primary interface:
CLI |
axon install,axon uninstall,axon init,axon run,axon get,axon logs,axon delete— manage the full lifecycle without writing YAML
The axon get commands (axon get task, axon get taskspawner, axon get workspace) do not support a --watch or -w flag, forcing users to fall back to kubectl for this common monitoring workflow.
Expected Behavior
axon get commands should support a --watch (or -w) flag to watch resources for changes, matching the kubectl get --watch behavior. This would enable:
axon get tasks --watch
axon get tasks -w
axon get taskspawners -wImpact
This creates an inconsistent user experience where:
- Users learn to use the
axonCLI for most operations - But must fall back to
kubectlspecifically for watching resources - The examples reinforce using
kubectlinstead of the native CLI
User Journey
A typical new user workflow currently requires mixing both tools:
# Use axon CLI
axon run -p "Fix bug #42"
# Switch to kubectl for watching
kubectl get tasks -w
# Switch back to axon for logs
axon logs <task-name> -fSuggested Fix
Add --watch flag support to axon get commands, similar to kubectl get --watch. Then update examples to use axon get tasks -w instead of kubectl get tasks -w for consistency.
Related
- Issue Examples: Use 'axon logs' instead of 'kubectl logs' for better CLI consistency #248: Examples use
kubectl logsinstead ofaxon logs - Issue CLI UX: 'axon run' should provide next-step guidance after task creation #183:
axon runshould provide next-step guidance