search

gpt-engineer-org / gpt-engineer

Platform to experiment with the AI Software Engineer. Terminal based. NOTE: Very different from https://gptengineer.app
MIT License
52.51k stars 6.82k forks source link

Improve `--sysinfo` by providing version data and env variables insights #1194

Open viborc opened 4 months ago

viborc commented 4 months ago

Feature description

Enhance the --sysinfo option to include additional useful and relevant information:

  1. Indicate the version of gpt-engineer that is running, and specify whether it is a released version or a development version (installed via pip or from GitHub repo).
  2. Include the output of which environment variables are set, ensuring that API key values and other sensitive data are masked. The focus is to verify that these variables are correctly set without exposing their values.

Motivation/Application

This feature is useful for several reasons:

  1. Version tracking - Knowing the exact version of gpt-engineer in use helps us diagnose issues more effectively, distinguishing between potential bugs in released versions and bugs in the dev version.
  2. Environment configuration insight - Including environment variables in the sysinfo output will provide valuable context about the user's setup, aiding in the debugging process while maintaining security by masking sensitive information.
  3. Security compliance - Masking API keys and other sensitive information in environment variables ensures no sensitive data is inadvertently exposed, maintaining user trust and compliance with security best practices.

Enhancing the --sysinfo option with these capabilities can streamline the debugging process, improve security, and provide clearer insights into user environments. This will enable us to resolve issues more quickly and achieve greater stability in our software.

I'm labeling this as a good first issue, too!

captivus commented 4 months ago

@viborc LGTM!

@Vikranth3140 or @satya-nutella, each of you have previously been involved in the gpte --sysinfo option. @Vikranth3140 wrote the current implementation. We'd welcome PRs from either of you and, obviously, new contributors!

Vikranth3140 commented 4 months ago

@captivus Sure, I will work on this issue and update soon.