Skip to content

docs: document --prompt-file flag for kelos run#912

Merged
gjkim42 merged 1 commit intomainfrom
kelos-task-910
Apr 5, 2026
Merged

docs: document --prompt-file flag for kelos run#912
gjkim42 merged 1 commit intomainfrom
kelos-task-910

Conversation

@kelos-bot
Copy link
Copy Markdown

@kelos-bot kelos-bot bot commented Apr 5, 2026

What type of PR is this?

/kind docs

What this PR does / why we need it:

The kelos run command supports a --prompt-file flag that reads the task prompt from a file (or from stdin when given -), but this flag is not documented anywhere. This PR adds it to:

  • docs/reference.md — the kelos run Flags section, placed right after --prompt with a note about mutual exclusivity
  • README.md — a usage example showing both file and stdin forms

Which issue(s) this PR is related to:

Fixes #910

Special notes for your reviewer:

The --prompt flag description was also updated from "(required)" to "(required unless --prompt-file is set)" to accurately reflect the mutual exclusivity.

Does this PR introduce a user-facing change?

NONE

Summary by cubic

Documented the --prompt-file flag for kelos run (with stdin support) so prompts can come from files or pipes, addressing #910. Also clarified that --prompt is required unless --prompt-file is set.

Written for commit e088439. Summary will update on new commits.

Add the --prompt-file flag to the kelos run Flags section in
docs/reference.md and add a usage example in README.md showing
both file and stdin forms.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

@kelos-bot kelos-bot bot added kind/docs and removed needs-kind Indicates an issue or PR lacks a kind/* label labels Apr 5, 2026
@gjkim42 gjkim42 added this pull request to the merge queue Apr 5, 2026
Merged via the queue into main with commit 5172984 Apr 5, 2026
39 of 57 checks passed
@gjkim42 gjkim42 deleted the kelos-task-910 branch April 5, 2026 14:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: 'kelos run --prompt-file' flag undocumented in CLI reference and README

1 participant