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

Add GPTE CLI argument to output system information #1143

Open
captivus opened this issue May 9, 2024 · 4 comments
Open

Add GPTE CLI argument to output system information #1143

captivus opened this issue May 9, 2024 · 4 comments
Assignees
Labels
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.

Comments

@captivus
Copy link
Collaborator

captivus commented May 9, 2024

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:

  • The CLI argument should use system-native commands or those available from the packages installed by GPTE (i.e. it should not require or install additional tools).
  • The CLI argument should not expose personally identifiable or other sensitive information.
  • When running gpte --sysinfo the application immediately outputs the system information without executing any of the other application flow and returns the user back to the command line.
  • When running gpte --sysinfo the application does not require an OpenAI (or any other LLM) API key but, rather, immediately generates the system information and outputs it.

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

Outputs of Linux operating system commands like:

  • uname -a
  • lsb_release -a
  • cat /proc/version

and, in Windows:

  • systeminfo

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

  • pip freeze
  • python --version
  • which python

These are indicative but not comprehensive.

This is a great first issue for a new contributor!

@captivus captivus 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 May 9, 2024
@captivus captivus changed the title Add GPTE CLI argument to include system information Add GPTE CLI argument to output system information May 9, 2024
@ATheorell
Copy link
Collaborator

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

@captivus
Copy link
Collaborator Author

captivus commented May 9, 2024

Outputs of Linux operating system commands like:

  • uname -a
  • lsb_release -a
  • cat /proc/version

and, in Windows:

  • systeminfo

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

  • pip freeze
  • python --version
  • which python

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

@satya-nutella
Copy link

@viborc can you assign me to this issue?

@viborc
Copy link
Collaborator

viborc commented May 23, 2024

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

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 triage Interesting but stale issue. Will be close if inactive for 3 more days after label added.
Projects
Status: Todo
Development

No branches or pull requests

4 participants