Skip to content

CLI: 'axon get' commands missing --watch flag for real-time monitoring #249

@gjkim42

Description

@gjkim42

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 -w
  • examples/01-simple-task/README.md: kubectl get tasks -w
  • examples/02-task-with-workspace/README.md: kubectl get tasks -w
  • examples/03-taskspawner-github-issues/README.md: kubectl get tasks -w
  • examples/04-taskspawner-cron/README.md: kubectl get tasks -w
  • self-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:

  1. Users learn to use the axon CLI for most operations
  2. But must fall back to kubectl specifically for watching resources
  3. The examples reinforce using kubectl instead 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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions