README.md

welk

What's inside the shell? welk manages `curl | sh` style package installs 🐌

---

🚧 Disclaimer: welk is alpha quality software. The API may change without warning between revisions. 🚧

welk is the package manager for software installed with curl and sh. welk gives you:

• A sandboxed environment for script execution during install
• Tracking of installed software. No more $HOME littered with random Kubernetes tools!
• Deletion of installed software.
• Automatic $PATH management. Your .zshrc has never looked better!

When documentation tells you to run curl <some url> | /bin/sh, use welk.

Getting welk

For now, head on over to the releases page and grab a binary.

Coming soon

Use curl | sh, of course! Run:

curl <TODO ADD FLAGS> <TODO URL> | sh

After welk is installed it will manage itself.

Make sure .local/bin is in your path, as defined by XDG.

Quick start

• Install new software with welk install $URL
• List installed software with welk list
• See the files installed by a script with welk info $URL
• Remove everything a script installed with welk delete $URL

Seasons

Open Source is free to play. Like all good free to play experiences, welk releases content and feature drops in seasons. Content from past seasons remains available to new users; we won't put it in a vault!

The current season is the Season of discovery.

The next season is the Season of the herald.

Find more upcoming and past seasons under milestones

Contributing

We would love your help!

welk is still a work in progress. You can help by:

• Opening a pull request to resolve an open issue.
• Adding a feature or enhancement of your own! If it might be big, please open an issue first so we can discuss it.
• Improving this README or adding other documentation to welk.
• Letting me know if you're using welk.