Skip to main content

Use ChatGPT for quick command-line advice

Project description

PyHowDoI

A utility for quick command-line guidance from ChatGPT.

⚠️ Use at your own risk. Carefully inspect all commands before running them. ⚠️

For example:

howdoi get a list of all files modified in the last five minute

Response:

find . -type f -mmin -5

No more trips to StackOverflow or man pages for simple things!

Installation

pip install pyhowdoi

Usage

You must set the environment variable OPENAPI_API_KEY in order for this utility to function. You will be charged for any usage of the API.

howdoi <any question here>
howdoi spin up a simple HTTP server
howdoi check how much disk space is currently being used
howdoi make a cron string that runs every wednesday at 5 am
howdoi find all lines that have TODO in them

If you wish to use special characters that might normally be interpreted by the shell, you can wrap your question in quotes:

howdoi 'replace all instance of $ with € in a file'

By default, the model gpt-3.5-turbo is used, but you can override this by setting the OPENAI_CHAT_MODEL environment variable:

export OPENAI_CHAT_MODEL=gpt-4
howdoi check that the hash of a file is correct

You can also pipe in standard input to provide additional context for the utility. For instance, you could pass in the help message or man page for a command:

curl -h 2>&1 | howdoi use curl to upload a file

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyhowdoi-1.0.0.tar.gz (2.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyhowdoi-1.0.0-py3-none-any.whl (2.9 kB view details)

Uploaded Python 3

File details

Details for the file pyhowdoi-1.0.0.tar.gz.

File metadata

  • Download URL: pyhowdoi-1.0.0.tar.gz
  • Upload date:
  • Size: 2.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Darwin/22.5.0

File hashes

Hashes for pyhowdoi-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e386cce71fd718783d581eca94d96777639bf57aef821d5be3b7cb1048acdee6
MD5 acf986dffeff0ade85e7a784969849dd
BLAKE2b-256 81d4fc85e842a0c8914bf803e37a27851cbf538fcfff8691d94fc90a921dff83

See more details on using hashes here.

File details

Details for the file pyhowdoi-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: pyhowdoi-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 2.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Darwin/22.5.0

File hashes

Hashes for pyhowdoi-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b3c3ae85bedd57410c77e62a266759d4db1729e01c5b4282da579259fe9a382e
MD5 a4712ceac22e506dafc7228863d39c0c
BLAKE2b-256 9d35074f2931e899148c114b8b23832fddbe229318b76cf49e38381c026e82fc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page