-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Milestone
Description
Problem
All langstar prompt subcommands have inconsistent --help documentation. The help text still shows the old flag name and is missing the new text format.
Current Issues
All prompt subcommands affected:
prompt listprompt getprompt searchprompt pushprompt pull
Current help text:
-f, --format <FORMAT>
Output format (json or table) [env: LANGSTAR_OUTPUT_FORMAT=]
Expected help text:
-o, --output <FORMAT>
Output format (table, json, or text) [env: LANGSTAR_OUTPUT_FORMAT=]
Documentation Pattern Requirements
For prompt get <HANDLE> argument
IMPORTANT: Private prompts are the #1 use case. The short handle format must be the FIRST example.
Current order (needs fixing):
Arguments:
<HANDLE>
Prompt handle (e.g., "owner/prompt-name") or UUID
Can be: - Full handle: "langchain-ai/rag-prompt" - Short handle: "prompt-name" (prepends "-/" for private prompts) - UUID: "8fc72dfc-6213-4048-b025-0156b1b735ff"
Required order (private prompt first):
Arguments:
<HANDLE>
Prompt handle or UUID
Can be:
- Short handle: "prompt-name" (for private prompts, prepends "-/")
- Full handle: "owner/prompt-name" (e.g., "langchain-ai/rag-prompt")
- UUID: "8fc72dfc-6213-4048-b025-0156b1b735ff"
Example: langstar prompt get my-prompt
For prompt pull <HANDLE> argument
Similarly, update prompt pull to show the private prompt example first (currently only shows "owner/prompt-name").
Tasks
- Update
prompt listhelp: flag name and format options - Update
prompt gethelp: flag name, format options, AND reorder<HANDLE>examples to show private prompt first - Update
prompt searchhelp: flag name and format options - Update
prompt pushhelp: flag name and format options - Update
prompt pullhelp: flag name, format options, AND add<HANDLE>examples (private prompt first) - Ensure consistency: all should use
-o, --outputand list "table, json, or text" - Verify env var name remains
LANGSTAR_OUTPUT_FORMAT
Testing Verification
Run each command and verify the output:
# Should all show -o, --output with "table, json, or text"
langstar prompt list --help | grep -A2 'output'
langstar prompt get --help | grep -A2 'output'
langstar prompt search --help | grep -A2 'output'
langstar prompt push --help | grep -A2 'output'
langstar prompt pull --help | grep -A2 'output'
# Verify <HANDLE> documentation shows private prompt example first
langstar prompt get --help | grep -A10 'HANDLE'
langstar prompt pull --help | grep -A10 'HANDLE'Context
Users are getting confused about how to get details for private prompts (the #1 use case), so documentation must emphasize the short handle format first.
References
- Parent: ls-prompt-ux milestone - Improve UX consistency across prompt commands #668 (ls-prompt-ux milestone)
- Sibling: 668.1-handle-consistency Make prompt pull accept same handle formats as prompt get #669 (handle consistency)
- Version: langstar 2.1.0
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels