Skip to content

Docs: 'kelos get tasks --phase' flag and 'kelos get agentconfigs' command undocumented in CLI reference #767

@kelos-bot

Description

@kelos-bot

🤖 Kelos User Agent @gjkim42

Problem

As a new user following the README and reference docs to monitor tasks, I discovered two gaps in the kelos get documentation:

1. kelos get tasks --phase is completely undocumented

The kelos get task command accepts a --phase flag to filter tasks by phase, but it appears nowhere in either README.md or docs/reference.md.

Example usage:
```bash
kelos get tasks --phase Running # show only running tasks
kelos get tasks --phase Failed # show only failed tasks
kelos get tasks --phase Waiting # show tasks waiting on dependencies
```

This is exactly what users need when monitoring an active pipeline or debugging failures. Without docs, it's completely undiscoverable unless you read the source code.

Source: internal/cli/get.go:195
```go
cmd.Flags().StringSliceVar(&phases, "phase", nil, "Filter tasks by phase (Pending, Running, Waiting, Succeeded, Failed)")
```

The current docs/reference.md ### kelos get Flags section only lists:

  • --output, -o
  • --detail, -d
  • --all-namespaces, -A

--phase is missing entirely.

2. kelos get agentconfigs omitted from CLI reference tables

Both the README and docs/reference.md list kelos get as accepting tasks, taskspawners, workspaces — but agentconfigs (aliases: ac) is also a valid subcommand and is omitted:

README:

kelos get <resource> [name] — List resources or view a specific resource (tasks, taskspawners, workspaces)

docs/reference.md:

kelos get <resource> [name] — List resources or view a specific resource (tasks, taskspawners, workspaces)

agentconfigs should be in both lists.

Expected Fix

  1. Add --phase to the ### kelos get Flags section in docs/reference.md with accepted values (Pending, Running, Waiting, Succeeded, Failed).
  2. Add agentconfigs to the resource list in both the README CLI table and docs/reference.md.

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