🤖 Kelos User Agent @gjkim42
Problem
As a new user following the documentation, I discovered that the CLI reference in both README.md and docs/reference.md is incomplete relative to what the CLI actually supports. Three features are silently absent:
1. kelos get agentconfig is undocumented
Both the README and docs/reference.md describe kelos get as:
kelos get <resource> [name] List resources or view a specific resource (tasks, taskspawners, workspaces)
But the CLI also supports agentconfig / agentconfigs / ac as a resource type (see internal/cli/get_agentconfig.go). A new user who creates an AgentConfig via kelos create agentconfig has no way to know from the docs that they can list it with kelos get agentconfig.
Similarly, kelos delete agentconfig is implemented but not mentioned anywhere in the CLI reference (the docs show tasks, taskspawners, workspaces only).
2. kelos get task --phase filter is undocumented
The kelos get task command supports a --phase flag for filtering tasks by phase (Pending, Running, Waiting, Succeeded, Failed), implemented in internal/cli/get.go. This flag does not appear in the kelos get flags section of docs/reference.md:
### `kelos get` Flags
- `--output, -o`: Output format (yaml or json)
- `--detail, -d`: Show detailed information for a specific resource
- `--all-namespaces, -A`: List resources across all namespaces
This is particularly useful for monitoring running tasks (kelos get task --phase Running).
3. kelos delete --all flag is undocumented
The kelos delete task, kelos delete workspace, kelos delete taskspawner, and kelos delete agentconfig subcommands all support --all to delete every resource of that type in the namespace. This flag is not mentioned anywhere in the CLI reference.
Impact
These are features a new user would never discover from the docs. They'd either resort to trial-and-error or kubectl directly — defeating the purpose of having a kelos CLI.
Suggested Fix
Update docs/reference.md and README.md:
- Add
agentconfigs to the resource types listed for kelos get and kelos delete
- Add
--phase to the kelos get flags section (task-specific, e.g. --phase: Filter tasks by phase — Pending, Running, Waiting, Succeeded, Failed — kelos get task only)
- Add
--all to a kelos delete flags section (delete all resources of the specified type in the namespace)
🤖 Kelos User Agent @gjkim42
Problem
As a new user following the documentation, I discovered that the CLI reference in both
README.mdanddocs/reference.mdis incomplete relative to what the CLI actually supports. Three features are silently absent:1.
kelos get agentconfigis undocumentedBoth the README and
docs/reference.mddescribekelos getas:But the CLI also supports
agentconfig/agentconfigs/acas a resource type (seeinternal/cli/get_agentconfig.go). A new user who creates an AgentConfig viakelos create agentconfighas no way to know from the docs that they can list it withkelos get agentconfig.Similarly,
kelos delete agentconfigis implemented but not mentioned anywhere in the CLI reference (the docs showtasks,taskspawners,workspacesonly).2.
kelos get task --phasefilter is undocumentedThe
kelos get taskcommand supports a--phaseflag for filtering tasks by phase (Pending,Running,Waiting,Succeeded,Failed), implemented ininternal/cli/get.go. This flag does not appear in thekelos getflags section ofdocs/reference.md:This is particularly useful for monitoring running tasks (
kelos get task --phase Running).3.
kelos delete --allflag is undocumentedThe
kelos delete task,kelos delete workspace,kelos delete taskspawner, andkelos delete agentconfigsubcommands all support--allto delete every resource of that type in the namespace. This flag is not mentioned anywhere in the CLI reference.Impact
These are features a new user would never discover from the docs. They'd either resort to trial-and-error or
kubectldirectly — defeating the purpose of having akelosCLI.Suggested Fix
Update
docs/reference.mdandREADME.md:agentconfigsto the resource types listed forkelos getandkelos delete--phaseto thekelos getflags section (task-specific, e.g.--phase: Filter tasks by phase —Pending,Running,Waiting,Succeeded,Failed—kelos get taskonly)--allto akelos deleteflags section (delete all resources of the specified type in the namespace)