[INIT] install VSCode extension #699

mohammedahmed18 · 2025-08-30T14:30:36Z

PR Type

Enhancement

Description

Introduce vscode-install CLI subcommand
Implement VSCode extension installer with progress bar
Invoke extension install in init command flow

Diagram Walkthrough

flowchart LR
  Parser["ArgParser"]
  InitCmd["init command"]
  VSCodeCmd["vscode-install command"]
  Parser -- "init" --> InitCmd
  Parser -- "vscode-install" --> VSCodeCmd
  InitCmd -- "run install_vscode_extension" --> VSCodeCmd

File Walkthrough

Relevant files

Enhancement

cli.py `Add VSCode install subcommand` codeflash/cli_cmds/cli.py Imported `install_vscode_extension` in CLI Added `vscode-install` subparser and handler	+4/-1
cmd_init.py `Implement VSCode extension installation` codeflash/cli_cmds/cmd_init.py Imported `shutil` and `progress_bar` Added `install_vscode_extension` function Called installer in `init_codeflash` flow	+35/-1

…he init command

github-actions · 2025-08-30T14:31:36Z

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review Missing Import The `install_vscode_extension` function invokes `click.echo` but `click` is not imported, which will cause a `NameError` at runtime. def install_vscode_extension() -> None: vscode_path = shutil.which("code") if not vscode_path: return error = "" with progress_bar("Installing Codeflash for VSCode…"): try: result = subprocess.run( [vscode_path, "--install-extension", "codeflash.codeflash", "--force"], check=True, text=True, timeout=60, capture_output=True, ) except subprocess.TimeoutExpired: error = "Installation timed out." except subprocess.CalledProcessError as e: error = e.stderr or "Unknown error." if error: click.echo("❌ Failed to install Codeflash for VSCode.") click.echo(error.strip()) else: output = (result.stdout or "").lower() if "already installed" in output: click.echo("✅ Codeflash for VSCode is already installed.") return click.echo("✅ Installed the latest version of Codeflash for VSCode.") Silent Skip If the VSCode CLI (`code`) is not found (`vscode_path` is `None`), the function returns silently without informing the user. Consider logging or echoing a warning so users know why the extension wasn't installed. vscode_path = shutil.which("code") if not vscode_path: return error = ""

github-actions · 2025-08-30T14:32:14Z

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Use console for output Replace raw `click.echo` calls with the existing `console` to ensure consistent output handling and avoid undefined references. Use styled output for clarity. codeflash/cli_cmds/cmd_init.py [829-830] -click.echo("❌ Failed to install Codeflash for VSCode.") -click.echo(error.strip()) +console.print("[red]❌ Failed to install Codeflash for VSCode.[/]") +console.print(f"[red]{error.strip()}[/]") Suggestion importance[1-10]: 6 __ Why: The raw `click.echo` calls skip styled output and diverge from existing `console` usage; replacing them with `console.print` ensures consistency and improves UX.	Low
General	Notify missing VSCode CLI Notify the user when the VSCode CLI isn't found before returning, to avoid silent failures. Use `console.print` for consistency. codeflash/cli_cmds/cmd_init.py [809-811] vscode_path = shutil.which("code") if not vscode_path: + console.print("[yellow]⚠️ VSCode CLI not found; skipping extension installation.[/]") return Suggestion importance[1-10]: 6 __ Why: Silently returning when the VSCode CLI is missing can confuse users; adding a `console.print` warning enhances feedback and aligns with existing logging.	Low

Saga4 · 2025-08-30T20:08:30Z

codeflash/cli_cmds/cmd_init.py

+            error = e.stderr or "Unknown error."
+
+    if error:
+        click.echo("❌ Failed to install Codeflash for VSCode.")


Rather than failed msg, we can suggest user to install VSC extension and error msg can go to our telemetry for our own logs.

misrasaurabh1 · 2025-09-01T22:50:00Z

codeflash/cli_cmds/cmd_init.py



+def install_vscode_extension() -> None:
+    vscode_path = shutil.which("code")


does vscode automatically install the "code" cli or does the user have to install it manually by following this step?
my question is that is it justified to always assume that code exists? If not , is there a more robust way to discover the installation?

on linux systems, if you use your package manager like apt or pacman ...
you will get the cli in your path without doing extra step.

for macos users they need to add it to their path manually after the installation
https://code.visualstudio.com/docs/setup/mac#_configure-the-path-with-vs-code

another workaround, without using the cli is to manually download the vsix file, unzip it, place it in the vscode installation path, in linux it would be:

~/.vscode/extensions (official vscode)

~/.vscode-oss/extensions (codium)

~/.windsurf/extensions

~/.cursor/extensions
(not sure about macos but it should be in Application Support dir)

then manually add the codeflash identifier to the extensions.json file.

but I guess we would need this workaround eventually specially for cursor: https://forum.cursor.com/t/command-line-list-extensions/103565/13

so I'll add this manual installation as a fallback

but we still need to download the vsix file from somewhere, and it's a bit tricky to do that from the official marketplace, that's why we need to push this to the open vsx registery @Saga4 as they have an api for that

another workaround, without using the cli is to manually download the vsix file, unzip it, place it in the vscode installation path, in linux it would be:

as someone who has continuously had issues with the code cli over the years on basically all platforms, if we can place the VSIX archive where it belongs directly, and it work out of the box, I much prefer to do that.

misrasaurabh1 · 2025-09-01T22:51:22Z

codeflash/cli_cmds/cmd_init.py

+                [vscode_path, "--install-extension", "codeflash.codeflash", "--force"],
+                check=True,
+                text=True,
+                timeout=60,


if it really takes that much time, i am also thinking that we can run it in parallel with the other init steps and only print that successfully installed the vs code extension.
I am concerned about the blocking experience here

it doesn't the extension is around 250kb

it takes 2 seconds to initialize the cli and install the extension

but yeah let's run it in parallel, if we are going to manually download and and install the extension #699 (comment)

misrasaurabh1 · 2025-09-01T22:52:03Z

codeflash/cli_cmds/cmd_init.py

+        return
+
+    error = ""
+    with progress_bar("Installing Codeflash for VSCode…"):


one more thing - what if they have cursor installed? we should also support installing codeflash there

yeah, I think for cursor we would need to manually add it because the cli is not working for many people (including me) #699 (comment)

…stall-vscode-extension

misrasaurabh1 · 2025-09-14T05:43:49Z

@mohammedahmed18 whats the status with this?

mohammedahmed18 · 2025-09-14T13:17:25Z

@misrasaurabh1 going to manually download the extension in .vscode dir as a fallback if the cli not found

Will start on thet tomorrow

…stall-vscode-extension

…ai/codeflash into init/install-vscode-extension

misrasaurabh1 · 2025-09-23T02:09:23Z

@Saga4 to review

misrasaurabh1 · 2025-10-20T17:24:45Z

@mohammedahmed18 whats going on here?

mohammedahmed18 · 2025-10-20T21:20:05Z

@misrasaurabh1 after the windows support I still need to make sure this still works on windows,
will borrow a windows machine and test it

misrasaurabh1 · 2025-10-20T21:40:36Z

@mohammedahmed18 if this works for mac then lets merge it, unless you have a quick windows machine. After that you can ensure that this works for windows. We should not let PRs get stale.

KRRT7 · 2025-10-20T21:49:50Z

let's just merge it, I'll test it on windows later and merge any necessary fixes.

mohammedahmed18 · 2025-10-20T23:03:21Z

@KRRT7 okay it should be ready then

mohammedahmed18 added 2 commits August 30, 2025 17:21

Merge branch 'install the latest version of vscode extension during t…

06ff851

…he init command

vscode-install command

f0f38b5

mohammedahmed18 requested review from KRRT7 and misrasaurabh1 August 30, 2025 14:30

github-actions bot added the Review effort 2/5 label Aug 30, 2025

Saga4 reviewed Aug 30, 2025

View reviewed changes

posthog events

c1368e7

mohammedahmed18 requested a review from Saga4 August 30, 2025 21:17

misrasaurabh1 reviewed Sep 1, 2025

View reviewed changes

mohammedahmed18 and others added 3 commits September 2, 2025 16:28

Merge branch 'main' of github.com:codeflash-ai/codeflash into init/in…

bcbd55d

…stall-vscode-extension

install vscode and exit

dc22b4a

Merge branch 'main' into init/install-vscode-extension

bc898cf

mohammedahmed18 added 4 commits September 18, 2025 16:12

Merge branch 'main' of github.com:codeflash-ai/codeflash into init/in…

574e1b5

…stall-vscode-extension

manually install the extension from the registery

73d1e92

Merge branch 'init/install-vscode-extension' of github.com:codeflash-…

ed89fa8

…ai/codeflash into init/install-vscode-extension

manually install the extension from openvsx

cf876b6

Merge branch 'main' into init/install-vscode-extension

2973578

KRRT7 approved these changes Oct 20, 2025

View reviewed changes

mohammedahmed18 merged commit 9223252 into main Oct 21, 2025
22 checks passed



		def install_vscode_extension() -> None:
		vscode_path = shutil.which("code")

[INIT] install VSCode extension #699

[INIT] install VSCode extension #699

Uh oh!

Conversation

mohammedahmed18 commented Aug 30, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Type

Description

Diagram Walkthrough

File Walkthrough

Uh oh!

github-actions bot commented Aug 30, 2025

PR Reviewer Guide 🔍

Uh oh!

github-actions bot commented Aug 30, 2025

PR Code Suggestions ✨

Uh oh!

Saga4 Aug 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mohammedahmed18 Sep 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

misrasaurabh1 commented Sep 14, 2025

Uh oh!

mohammedahmed18 commented Sep 14, 2025

Uh oh!

misrasaurabh1 commented Sep 23, 2025

Uh oh!

misrasaurabh1 commented Oct 20, 2025

Uh oh!

mohammedahmed18 commented Oct 20, 2025

Uh oh!

misrasaurabh1 commented Oct 20, 2025

Uh oh!

KRRT7 commented Oct 20, 2025

Uh oh!

mohammedahmed18 commented Oct 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mohammedahmed18 commented Aug 30, 2025 •

edited by github-actions bot

Loading

Saga4 Aug 30, 2025 •

edited

Loading

mohammedahmed18 Sep 2, 2025 •

edited

Loading