feat(cli): add explicit proxy option in cli - #2526

Thanks for adding this important feature! The implementation looks good. Before we can merge this, could you please add some tests to verify that the proxy setting is correctly applied? Also, could you please add documentation for the new --proxy option to the docs/cli/configuration.md file? Also the web-fetch tool has it's own fallback http fetch that should be included in these changes.

thanks for your advice:

1. I've add extra UT for proxy options.
2. Updated the cli document for proxy options.
3. Set proxy for web-fetch tool if proxy option set.

This is making good progress, but it looks like you have some failing tests, and need to resolve some merge conflicts.

This is making good progress, but it looks like you have some failing tests, and need to resolve some merge conflicts.

Yeah, i'm working on it ~

This is making good progress, but it looks like you have some failing tests, and need to resolve some merge conflicts.

Yeah, i'm working on it ~

@allenhutchison I've tested it locally, could plz re-run the ci task?

Thanks for the great work on this PR, @warjiang! Adding proxy support is a fantastic improvement.

I did a deeper dive into the codebase to see if there were any other places that make network requests, and I found a few spots that might also need to be updated to use the new proxy setting.

Here are the files I noticed:

1. packages/core/src/core/modelCheck.ts: The fetch call on line 46 doesn't seem to be using the proxy.
2. packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts: The https.request call on line 110 for sending telemetry data could also benefit from the proxy.
3. scripts/telemetry_utils.js: The getJson function uses curl to fetch release information from GitHub. This curl command should probably include the proxy as well.

Let me know what you think! Happy to discuss further.

Thanks for the great work on this PR, @warjiang! Adding proxy support is a fantastic improvement.

I did a deeper dive into the codebase to see if there were any other places that make network requests, and I found a few spots that might also need to be updated to use the new proxy setting.

Here are the files I noticed:

1. packages/core/src/core/modelCheck.ts: The fetch call on line 46 doesn't seem to be using the proxy.
2. packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts: The https.request call on line 110 for sending telemetry data could also benefit from the proxy.
3. scripts/telemetry_utils.js: The getJson function uses curl to fetch release information from GitHub. This curl command should probably include the proxy as well.

Let me know what you think! Happy to discuss further.

thanks for you comprehensive advice,

1. for packages/core/src/core/modelCheck.ts, you're right, and I add the proxy when fetch model info:
   https://github.com/google-gemini/gemini-cli/blob/8e3d6c43e6b9d9f99704d2df319ddca00efe0f98/packages/core/src/core/modelCheck.ts#L48-L58

2. for packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts, because the request use https.request not build-in fetch method, so need extra proxy-agent for proxy request, we follow the implementation of kubernetes-client/javascript (I've tested the implementation of proxy, and I thinks it's robus enough)

3. for scripts/telemetry_utils.js, I thinks we should split another PR to add feature of proxy, reasons as following:

   • otel is started through sub process, and the config for otel is load from setting file instead of options, when we start gemini-cli, we'll not start the otel collector directly, the collector is started by running npm run telemetry or npm run start:gcp, the proxy option should be add here not in cli.
   • currently, the way to parse command line arguments is simple, it read the process.argv and match the keyword like:
     

     gemini-cli/scripts/telemetry.js

     Lines 52 to 70 in edd69cb

     	const allowedTargets = ['local', 'gcp'];
     	const targetArg = process.argv.find((arg) => arg.startsWith('--target='));
     	if (targetArg) {
     	const potentialTarget = targetArg.split('=')[1];
     	if (allowedTargets.includes(potentialTarget)) {
     	target = potentialTarget;
     	console.log(`⚙️ Using command-line target: ${target}`);
     	} else {
     	console.error(
     	`🛑 Error: Invalid target '${potentialTarget}'. Allowed targets are: ${allowedTargets.join(', ')}.`,
     	);
     	process.exit(1);
     	}
     	} else if (settingsTarget) {
     	console.log(
     	`⚙️ Using telemetry target from settings.json: ${settingsTarget}`,
     	);
     	}

     
     here we need to read --target option to start gcp or local otel collector, if we use --target gcp, the implementation above will not detect target=gcp correctly, and fallback to local collector

   so, , I want to add arguments parsing in another PR and add proxy options in the command line and setting file at the same time.

@allenhutchison could you help me recheck the PR. BTW the gemini-bot label the PR with status/need-issue, should I create extra issue related to the PR for better description?

Thanks for the great work on this PR, @warjiang! Adding proxy support is a fantastic improvement.
I did a deeper dive into the codebase to see if there were any other places that make network requests, and I found a few spots that might also need to be updated to use the new proxy setting.
Here are the files I noticed:

1. packages/core/src/core/modelCheck.ts: The fetch call on line 46 doesn't seem to be using the proxy.
2. packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts: The https.request call on line 110 for sending telemetry data could also benefit from the proxy.
3. scripts/telemetry_utils.js: The getJson function uses curl to fetch release information from GitHub. This curl command should probably include the proxy as well.

Let me know what you think! Happy to discuss further.

thanks for you comprehensive advice,

1. for packages/core/src/core/modelCheck.ts, you're right, and I add the proxy when fetch model info:
   https://github.com/google-gemini/gemini-cli/blob/8e3d6c43e6b9d9f99704d2df319ddca00efe0f98/packages/core/src/core/modelCheck.ts#L48-L58

2. for packages/core/src/telemetry/clearcut-logger/clearcut-logger.ts, because the request use https.request not build-in fetch method, so need extra proxy-agent for proxy request, we follow the implementation of kubernetes-client/javascript (I've tested the implementation of proxy, and I thinks it's robus enough)

3. for scripts/telemetry_utils.js, I thinks we should split another PR to add feature of proxy, reasons as following:

   • otel is started through sub process, and the config for otel is load from setting file instead of options, when we start gemini-cli, we'll not start the otel collector directly, the collector is started by running npm run telemetry or npm run start:gcp, the proxy option should be add here not in cli.

   • currently, the way to parse command line arguments is simple, it read the process.argv and match the keyword like:
     

     gemini-cli/scripts/telemetry.js

     Lines 52 to 70 in edd69cb

     	const allowedTargets = ['local', 'gcp'];
     	const targetArg = process.argv.find((arg) => arg.startsWith('--target='));
     	if (targetArg) {
     	const potentialTarget = targetArg.split('=')[1];
     	if (allowedTargets.includes(potentialTarget)) {
     	target = potentialTarget;
     	console.log(`⚙️ Using command-line target: ${target}`);
     	} else {
     	console.error(
     	`🛑 Error: Invalid target '${potentialTarget}'. Allowed targets are: ${allowedTargets.join(', ')}.`,
     	);
     	process.exit(1);
     	}
     	} else if (settingsTarget) {
     	console.log(
     	`⚙️ Using telemetry target from settings.json: ${settingsTarget}`,
     	);
     	}

     here we need to read --target option to start gcp or local otel collector, if we use --target gcp, the implementation above will not detect target=gcp correctly, and fallback to local collector

   so, , I want to add arguments parsing in another PR and add proxy options in the command line and setting file at the same time.

@Dcatfly can we cooperate with the proxy feature. Apart from proxy for cli, I think there is need to add proxy feature for telemetry, like init the otel collector from github, report metrics to gcp endpoint, maybe there still need extra work about this.

I find the problem of ci, the cause is the trailing space at the end of the comment line

howerver, run format task in local machine(for me is macos) cannot find the error.

@warjiang I tried resolving conflicts for you via the GitHub UI but looks like it missed a bit 😢 . Would you mind fixing the build real quick and re-pushing. Also could you @ me directly once you're done. Apologeis for all this back and forth. There's been so much volume in the repo it's hard to keep up so the @'s have been helpful

Never mind, I know it's really hard to maintain a popular oss repo, especially the repo also iterated in a high speed.

@NTaylorMullen all conflicts have been resolved and re-tested in forked repo. Let's move forward ~