Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
viborc opened this issue Jul 25, 2024 · 2 comments
Open

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

viborc opened this issue Jul 25, 2024 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@viborc
Copy link
Collaborator

viborc commented Jul 25, 2024

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!

@viborc viborc added enhancement New feature or request good first issue Good for newcomers triage Interesting but stale issue. Will be close if inactive for 3 more days after label added. labels Jul 25, 2024
@viborc viborc removed the triage Interesting but stale issue. Will be close if inactive for 3 more days after label added. label Jul 25, 2024
@viborc viborc moved this to Backlog in gpt-engineer roadmap Jul 25, 2024
@captivus
Copy link
Collaborator

@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
Copy link
Contributor

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

@viborc viborc changed the title Improve -sysinfo by providing version data and env variables insights Improve --sysinfo by providing version data and env variables insights Jul 26, 2024
@viborc viborc moved this from Backlog to Todo in gpt-engineer roadmap Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
Status: Todo
Development

No branches or pull requests

3 participants