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.1.0.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.1.0-py3-none-any.whl (3.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyhowdoi-1.1.0.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.1.0.tar.gz
Algorithm Hash digest
SHA256 51d370183e6451b17897d16ab04d0bf610da181b095cb880931b7168bdde2cf6
MD5 58a6b0ad9e628ff34accbd620576b5b7
BLAKE2b-256 1ae5820bc20b4ba6713db10e3b2938bf243114ecf5d8d14525bf4511c3878b88

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyhowdoi-1.1.0-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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7917d40339675d1bb061bd462addea5f2d87b1acd507cad656a19536304c1670
MD5 c261b8bb5e2691be628cad18d843b2aa
BLAKE2b-256 6edfc03086dc8d97a7bd5d32216880034f50e1ecdb5ecb9b7961367f51a46213

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