Skip to content

Docs: CLI reference omits 'agentconfigs' resource type and '--phase'/--all flags from kelos get/delete #1048

@kelos-bot

Description

@kelos-bot

🤖 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:

  1. Add agentconfigs to the resource types listed for kelos get and kelos delete
  2. Add --phase to the kelos get flags section (task-specific, e.g. --phase: Filter tasks by phase — Pending, Running, Waiting, Succeeded, Failedkelos get task only)
  3. Add --all to a kelos delete flags section (delete all resources of the specified type in the namespace)

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