CLI UX: Improve error message when Axon controller is not installed
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 331
- Forks
- 40
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 70
Description
Problem
When a user tries to use axon get, axon run, or other commands before running axon install, they get a cryptic Kubernetes RBAC error:
Error: listing tasks: tasks.axon.io is forbidden: User "system:serviceaccount:default:default" cannot list resource "tasks" in API group "axon.io" in the namespace "default"
For new users following the Quick Start, this error provides no actionable guidance about what to do next.
Current Experience
A new user might:
- Install the CLI:
go install github.com/axon-core/axon/cmd/axon@latest - Run
axon initand configure their token - Try to run a task:
axon run -p "test" - Get the cryptic RBAC error
- Not realize they need to run
axon installfirst
Expected Experience
The error should be user-friendly and actionable:
Error: Axon controller is not installed in the cluster
To install Axon, run:
axon install
For more information: https://github.com/axon-core/axon#quick-start
Technical Approach
The CLI could detect this scenario by:
- Checking if the CRDs exist (
tasks.axon.io, etc.) - If CRDs don't exist, provide a helpful error message
- This check could be done before attempting the operation
Alternatively, catch the specific RBAC error pattern and provide a more helpful message when it matches "tasks.axon.io is forbidden" or "no matches for kind".
Impact
This will:
- Reduce confusion for new users
- Make the onboarding flow more intuitive
- Provide actionable next steps instead of cryptic errors
- Reduce support burden
Related Issues
This complements the Quick Start documentation improvements but requires a code change rather than just documentation.
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 by locating the CLI entry points for axon get, axon run, and related commands, then inspect how Kubernetes errors are currently surfaced. Compare the CRD-check and RBAC-error approaches described in the issue, and consider how the existing Quick Start flow is represented. Done means users receive actionable installation guidance instead of the cryptic RBAC or missing-kind error.
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
- 38/100