Skip to content

Fix --help for AI agents & humans #1060

@patrikbraborec

Description

@patrikbraborec

Summary

The --help output across all CLI commands needs improvements to be useful for both AI agents and human users.

Action Items

  • Add usage examples to all commands
  • Add links to docs in help output
  • Fix: actor --help never mentions it is an alias for apify actor
  • Fix: misleading command descriptions (e.g., runs says "Manages Actor run operations" but runs create doesn't exist)
  • Help should distinguish local Actor development commands from remote platform commands
  • Add new commands like search
  • Mark interactive commands explicitly (so agents know to avoid them / how to use them)
  • Be defensive: help as argument should work like --help
  • apify init --yes does not work in non-interactive mode (mark interactive commands, provide non-interactive alternatives)

Reference

  • gh and mcpc CLIs for inspiration on help output quality

Supersedes

Metadata

Metadata

Assignees

Labels

t-toolingIssues with this label are in the ownership of the tooling team.

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions