Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jbowes/welk

What's inside the shell? welk manages `curl | sh` style package installs 🐌
https://github.com/jbowes/welk

curl go golang hacktoberfest package package-management package-manager shell shell-script

Last synced: 2 months ago
JSON representation

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

Awesome Lists containing this project

README

        

welk


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


Alpha Quality
GitHub tag
Build Status
BSD license
codecov
Go Report Card


---

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

`welk` is the package manager for software installed with [`curl`][curl] and
[`sh`][sh]. `welk` gives you:
- A sandboxed environment for script execution during install
- Tracking of installed software. No more `$HOME` littered with random
[Kubernetes][k8s] tools!
- Deletion of installed software.
- Automatic `$PATH` management. Your [`.zshrc`][zsh] has never looked better!

When documentation tells you to run `curl | /bin/sh`, use `welk`.

## Getting `welk`

For now, head on over to the [releases](./releases) page and grab a binary.

### Coming soon

Use `curl | sh`, of course! Run:
```sh
curl | 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*](./milestone/2).

The next season is the [*Season of the herald*](./milestone/3).

Find more upcoming and past seasons under [milestones][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][issues].
- Adding a feature or enhancement of your own! If it might be big, please
[open an issue][enhancement] first so we can discuss it.
- Improving this `README` or adding other documentation to `welk`.
- Letting [me] know if you're using `welk`.

[curl]: https://curl.se/
[sh]: https://en.wikipedia.org/wiki/Unix_shell
[k8s]: https://kubernetes.io/
[zsh]: https://www.zsh.org/
[xdg]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html

[milestones]: ./milestones
[issues]: ./issues
[bug]: ./issues/new?labels=bug
[enhancement]: ./issues/new?labels=enhancement

[me]: https://twitter.com/jrbowes