Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yvan-sraka/kombucha
Simple aliases collection for YeAST
https://github.com/yvan-sraka/kombucha
aliases buildtools haskell shell yeast
Last synced: 14 days ago
JSON representation
Simple aliases collection for YeAST
- Host: GitHub
- URL: https://github.com/yvan-sraka/kombucha
- Owner: yvan-sraka
- License: gpl-3.0
- Created: 2018-03-17T12:41:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-05-12T19:47:05.000Z (over 2 years ago)
- Last Synced: 2024-10-16T01:28:22.606Z (29 days ago)
- Topics: aliases, buildtools, haskell, shell, yeast
- Language: Haskell
- Homepage:
- Size: 30.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Kombucha
_Simple aliases collection for [YeAST](https://github.com/yvan-sraka/YeAST)_
## What's that?
This repository contains scripts that offer a standard way to work with common UNIX utils.
The first idea is to always take input as the first positional argument and write the output on standard output, e.g:
```shell
@gcc main.c
# ... is equivalent to:
gcc main.c -o a.out && ./a.out
```
The second purpose is to offer the same user experience than [Haskell Stack](https://docs.haskellstack.org/en/stable/README/), e.g. [this script](https://github.com/yvan-sraka/uncomment) self install its build tools and dependencies at first run:
```haskell
#!/usr/bin/env stack
-- stack --install-ghc runghc --package regex-compat
import Text.Regex
main = interact (\xs -> subRegex (mkRegex "") xs "")
```
We try to provide an equivalent structure with other common language stacks, like e.g. Python:
```python
#!/usr/bin/env @python
# stack --virtual-env pypy3 --pip-install requirements.txt
print("Wow, it was smooth! I'm ready to build stuffs :)")
```
Kombucha aliases always start with the `@` symbol to not enter in conflict with existent software in your `PATH`.
By combining these utils we intent to help the writing of simpler and more robust build suites.
The idea of using GitHub as a service to handle aliases was directly inspired by [HomeBrew Formula](https://github.com/Homebrew/homebrew-core/tree/master/Formula)!
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
Get YeAST binary from source:
```shell
curl https://raw.githubusercontent.com/yvan-sraka/YeAST/master/install.sh -sSf | sh
```
### Build
You need an [Haskell build environment](https://www.haskell.org/downloads) on your computer, then just:
```shell
ghc kombucha.hs -o kombucha
```
You can also download an executable directly on the [release page](https://github.com/yvan-sraka/cleopatra/releases) of the repository.
### Usage
```shell
kombucha
```
#### Flags
- `-h`, `--help` Prints help information
- `-V`, `--version` Prints version information
#### Commands
- `update` Update aliases collection contained in `.kombucha` folder
```shell
export PATH="$HOME/.kombucha:$PATH"
# That's all!
```
## Contributing
## Roadmap
- [ ] Random UUID
- [ ] TODO Need a kind of namespace == Share $@ using environnement variable
## Submiting a new alias and others contributings
Submitting a package process TODO ...
Please read [CONTRIBUTING.md](https://github.com/yvan-sraka/Kombucha/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Authors
* [Yvan Sraka](https://github.com/yvan-sraka)
See also the list of [contributors](https://github.com/yvan-sraka/Kombucha/graphs/contributors) who participated in this project.
## License
This project is licensed under the 3rd version of GPL License - see the [LICENSE](https://github.com/yvan-sraka/Kombucha/blob/master/LICENSE) file for details.