Skip to main content

Get command line help using AI

Project description


features: ["asciinema"]

🛟 uh, halp?

demo

📦 Install

pip install uh-halp

⚙ Configure

$ uh reverse file.txt
>>> Need a groq key, it'll be saved to ~/.uh-keys: <paste here>
>> Saving groq key to ~/.uh-keys
tac file.txt

▶️ Usage

$ uh check my syslog
tail -f /var/log/syslog

$ uh clean up docker disk space
docker system prune -a

$ uh sync this shit to /home/gaz/project on gaz@server
rsync -avz --progress . gaz@server:/home/gaz/project

$ uh how much space have I got free here?
df -h .

$ uh gimme a socks proxy on 192.168.0.1
ssh -D 8080 username@192.168.0.1

$ uh check if the internet is up
ping -c 3 google.com

$ uh make annoying beeping noises randomly in the background forever
while true; do echo -e "\a"; sleep $((RANDOM % 10)); done &

🗒️ Notes

It currently defaults to Groq. If you want to use something else, open ~/.uh-config and change current and edit the config. If you want to add your own custom back-end, give the name of a module that has a query function in it, then fill in the parameters with templates vars in the example format. Use {key} as one of the params to send the key wherever you like (postdata, query param, cookie or other header).

Look before you paste. There's no protection against doing things like $(uh how do I break this computer?). So please don't just execute its output!

Seems to work well in bash and zsh on Linux and macOS. It's not had much testing elsewhere else. Windows, BSD, Solaris, zOS etc should also work.

⚠️ Disclaimer

If it blows your machine up it's your own fault. Don't run code produced by a language model without reading it.

⚖️ License

WTFPL with one additional clause: don't blame me!

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

uh_halp-0.1.8.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

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

uh_halp-0.1.8-py3-none-any.whl (9.1 kB view details)

Uploaded Python 3

File details

Details for the file uh_halp-0.1.8.tar.gz.

File metadata

  • Download URL: uh_halp-0.1.8.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for uh_halp-0.1.8.tar.gz
Algorithm Hash digest
SHA256 33206b6f5ae6011501d3eeefcd1706a0f66e6466c37ce7a8a4a37c5deeba85b3
MD5 b923c5cc48b1a05235589815e8b504fb
BLAKE2b-256 89916c39df0f9c5850dd1f23d0ee0a906af02b75525e144c288e7952721ae52a

See more details on using hashes here.

File details

Details for the file uh_halp-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: uh_halp-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 9.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for uh_halp-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b82694561102d21a5ab68690c0f8e10f6e2cd47f2122dbfbdcfe175d0b2849c6
MD5 81a23e695775632bb7029fec4af339b4
BLAKE2b-256 8a6b234fd83b16cfd93afa14b32754ecd9d22c364693a57d60c2915f415782fa

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