CLI: 'axon get' commands missing --watch flag for real-time monitoring
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 331
- Forks
- 40
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 70
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 -w
Impact
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> -f
Suggested 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 #248: Examples use
kubectl logsinstead ofaxon logs - Issue #183:
axon runshould provide next-step guidance
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the CLI entry points for axon get task, axon get taskspawner, and axon get workspace, then compare their behavior with the documented kubectl get ... -w workflow. Review the listed README files and update them to use the native commands once watch support works consistently for the resource types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, kubernetes
- Domain
- cli, devops
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100