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

See https://platform.openai.com/docs/models/overview for a full list of available models.

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.2.tar.gz (3.0 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.2-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyhowdoi-1.0.2.tar.gz
  • Upload date:
  • Size: 3.0 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.2.tar.gz
Algorithm Hash digest
SHA256 cbaedcf1cef35ae1f9c9c60151c676210cddc2217cef39fc1aef39b1b7f336b6
MD5 86f320f9020a3b3fd6e10728b27cdff0
BLAKE2b-256 457a0290722c5932d086fb998a4de02cc09ec6a3075e6455781a0029307f0821

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyhowdoi-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 3.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2322cffa9de255ae5607dcc34b1cb06fa7a0a7881755e8443b182f9569fae965
MD5 937cb13376d83e1e8b110a82714249d5
BLAKE2b-256 926cdd79a44bf43736eacbeef215f12828ab59904b4437b8e90c210203a12f5f

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