Skip to content

Conversation

@mashraf-222
Copy link
Contributor

@mashraf-222 mashraf-222 commented Nov 25, 2025

User description

Improves the UX of the GitHub app installation prompt during codeflash init by:

  • Changing "Press Enter" to "Press ENTER" (caps) to make the instruction more noticeable
  • Adding ">>> " prompt suffix to clearly indicate where user input is expected

This makes it easier for users to spot the instruction and understand they need to provide input.

image

PR Type

Enhancement


Description

  • Improve GitHub app prompt wording

  • Emphasize ENTER in instruction

  • Add ">>> " input prompt suffix


Diagram Walkthrough

flowchart LR
  CLI["CLI init flow"] -- "Install GitHub app step" --> Prompt["Updated prompt text and suffix"]
  Prompt -- "Launches" --> Browser["GitHub app install page"]
Loading

File Walkthrough

Relevant files
Enhancement
cmd_init.py
Clarify and highlight GitHub app install prompt                   

codeflash/cli_cmds/cmd_init.py

  • Update prompt text to "Please Press ENTER..."
  • Add prompt suffix ">>> " to highlight input
  • Keep default empty input and no default display
+2/-2     

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions
Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Copy/Capitalization

Consider lowercasing 'github' to 'GitHub' for brand consistency in the updated prompt line while you changed ENTER and suffix.

f"Finally, you'll need to install the Codeflash GitHub app by choosing the repository you want to install Codeflash on.{LF}"
f"I will attempt to open the github app page - https://github.com/apps/codeflash-ai/installations/select_target {LF}"
f"Please Press ENTER to open the page to let you install the app…{LF}",
default="",
UX Consistency

Verify that the new prompt_suffix '>>> ' aligns with other CLI prompts in the tool to maintain a consistent user experience.

prompt_suffix=">>> ",
show_default=False,

@github-actions
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Fix GitHub capitalization

Use the official prompt capitalisation and brand casing for clarity and
professionalism. Replace "github" with "GitHub".

codeflash/cli_cmds/cmd_init.py [1114]

-f"I will attempt to open the github app page - https://github.com/apps/codeflash-ai/installations/select_target {LF}"
+f"I will attempt to open the GitHub app page - https://github.com/apps/codeflash-ai/installations/select_target {LF}"
Suggestion importance[1-10]: 5

__

Why: Correcting "github" to "GitHub" improves professionalism and clarity, and the snippet matches the new hunk. It’s a minor but accurate and reasonable UI text fix.

Low
Discard unused prompt input

Ensure pressing only ENTER advances without requiring any input and that non-empty
input doesn't get misused. Explicitly discard the return value and validate that
prompt_suffix doesn't conflict with subsequent input reads.

codeflash/cli_cmds/cmd_init.py [1112-1120]

-click.prompt(
+_ = click.prompt(
     f"Finally, you'll need to install the Codeflash GitHub app by choosing the repository you want to install Codeflash on.{LF}"
     f"I will attempt to open the github app page - https://github.com/apps/codeflash-ai/installations/select_target {LF}"
     f"Please Press ENTER to open the page to let you install the app…{LF}",
     default="",
     type=click.STRING,
     prompt_suffix=">>> ",
     show_default=False,
 )
Suggestion importance[1-10]: 4

__

Why: The prompt's return value is unused; explicitly assigning it to _ is a minor readability/intent improvement. It doesn't change behavior or fix a bug, and concerns about prompt_suffix conflicts are speculative.

Low
Normalize prompt casing

Align message casing for readability; only capitalize the key action. Use "press
ENTER" to avoid mid-sentence capitalization noise.

codeflash/cli_cmds/cmd_init.py [1115]

-f"Please Press ENTER to open the page to let you install the app…{LF}",
+f"Please press ENTER to open the page to let you install the app…{LF}",
Suggestion importance[1-10]: 4

__

Why: Lowercasing "Press" to "press" improves consistency and readability of the prompt text. It’s a small, correct copy edit with limited impact.

Low

misrasaurabh1
misrasaurabh1 previously approved these changes Nov 25, 2025
Co-authored-by: Saurabh Misra <misra.saurabh1@gmail.com>
Co-authored-by: Saurabh Misra <misra.saurabh1@gmail.com>
@codeflash-ai
Copy link
Contributor

codeflash-ai bot commented Nov 26, 2025

⚡️ Codeflash found optimizations for this PR

📄 320% (3.20x) speedup for install_github_app in codeflash/cli_cmds/cmd_init.py

⏱️ Runtime : 10.8 seconds 2.56 seconds (best of 5 runs)

A new Optimization Review has been created.

🔗 Review here

Static Badge

@KRRT7 KRRT7 enabled auto-merge (squash) November 26, 2025 07:03
@KRRT7 KRRT7 merged commit cff6a30 into main Nov 26, 2025
20 of 22 checks passed
@KRRT7 KRRT7 deleted the ux/enhance-cli-prompt-visibility-github-app-installation branch November 26, 2025 07:32
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.

5 participants