gpt-engineer-org / gpt-engineer

Specify what you want it to build, the AI asks for clarification, and then builds it.
MIT License
51.31k stars 6.67k forks source link

Add GPTE CLI argument to output system information #1143

Open captivus opened 1 month ago

captivus commented 1 month ago

When running GPTE, it will be quite helpful to be able to quickly generate useful system information for use in debugging issues.

For example, this should be invoked as gpte --sysinfo.

This invocation should output system information in a standardized and useful way, so that users can readily copy and paste the output into GitHub, Discord, etc ...

Here are some requirements for this CLI argument:

Here are some examples of system information that should be returned by running gpte --sysinfo:

Outputs of Linux operating system commands like:

and, in Windows:

We should also include Python-specific information, like the output of:

These are indicative but not comprehensive.

This is a great first issue for a new contributor!

ATheorell commented 1 month ago

What specific system information do you think should be included in --sysinfo @captivus ?

captivus commented 1 month ago

Outputs of Linux operating system commands like:

and, in Windows:

We should also include Python-specific information, like the output of:

These are indicative but not comprehensive. I've updated the original issue description to reflect this guidance.

satya-nutella commented 1 month ago

@viborc can you assign me to this issue?

viborc commented 1 month ago

Hey, @satya-nutella, please update us briefly about your progress with this, when you catch a moment.

viborc commented 1 month ago

Thanks for joining today, @satya-nutella. Let's go and have a PR open with your work on this issue in the coming few days. Is that possible?

Vikranth3140 commented 3 weeks ago

Hey @viborc , I've tried to implement the --sysinfo CLI argument as suggested. This new feature outputs detailed system information, including the operating system, OS version, system architecture, Python version, and installed Python packages. This should help in debugging and troubleshooting.

Example Usage:

Run the following command to display the system information:

python main.py --sysinfo

Example Output:

os: Linux
os_version: #1 SMP Wed Dec 15 10:30:14 UTC 2021
architecture: x86_64
python_version: 3.10.2 (default, Jan 14 2022, 00:00:00) [GCC 7.5.0]
packages: {"typer": "0.4.0", "openai": "0.10.1", ...}

Summary of Changes:

Please review the changes and let me know if any adjustments are needed. I've created a pull request for this enhancement.

viborc commented 1 week ago

I see we are making good progress at https://github.com/gpt-engineer-org/gpt-engineer/pull/1169 so let's keep communicating about this issue there. Thanks for your good work and efforts!

Vikranth3140 commented 3 days ago

Hey @viborc, if possible please review my PR and let me know if any changes are to be done :)