1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
<h1 align="center">
pik
</h1>
> file-based task runner
## the goal
are you ever uncertain what to do after cloning a repository? `pik` aims to fix this by making tasks findable,
predictable and programmable.
running `pik` in any repository will index its own file-based task system, as well as supported external systems.
## getting started
0. if you are already using a supported external runner from [here](#supported-external-runners) and replace it
with `pik` (`just build` -> `pik build`)
1. create a `.pik` folder in your project
2. put a script in there, for example: `.pik/build.sh` containing `go build .`
3. you can now access this script from almost anywhere by calling `pik build`. If you want to trigger a specific
projects build, specify `pik project build`, where `project` is the folder name.
pik comes equipped with a tui that allows for target browsing and invoking. open it by running `pik`. the output also
gently reminds you how to run the invocation next time!
## current features
* run targets by their approximate name: `uwu build` will trigger `.uwu/build.sh`, or `.uwu/build.py`, or `make build`
depending on what's possible.
* including external targets from `just`
* specify source names to search for the target in that source explicitly: `uwu myproject build` can
run `../../myproject/.uwu/build.sh`
* unless overridden, targets will run in the directory where the `.uwu` folder resides.
* use `--all` flag to start out-of-tree targets without having to navigate to the directory.
* `--here` to run the target in the current working directory instead of the source directory.
* `--at` to run the target in an arbitrary location
* target tags in filenames which trigger flag behaviours
* aliases to sources through the `.alias` file
* tui for viewing and running targets
* descriptions for targets based on first comment in a target
* y/n confirmation with yes as default
* will be used if we have an uncertain target guess
* `--yes` to automatically confirm y/n prompts
* autoload .env files
* both the project root and `.pik` folder will be searched
* values specified with `--env` will be tried as pre- and suffixes: `--env asdf` will load `.env-asdf`
and `asdf.env` if they exist.
* env files are reread for every trigger, meaning you can have a pre-trigger fetch credentials and save it in .env
* create any kind of target: high-level support for shell and python, and arbitrary shells with the shebang.
### supported external runners
* `just`
* if you want any more let me know and it should be done very fast
## planned features
As this program has already gone through a number of iterations and forms, this (hopefully permanent) version will need
time to catch up with all the features it used to have. This list is not exhaustive, but it is ordered by importance I
attach to these features.
* runner for executable files
* this will also enable arbitrary shells like node by way of the shebang
* indexers for other target types such as `make` and `npm`
* whitelists for external runners in `.pik`
* adding descriptions to external targets
* expand tui:
* support for categories and ordering of targets through the `.order` file
* search
* more hotkeys (filter jumping, toggle all, etc.)
* git pre-commit and pre-push triggers
* linking sources together by `.include` and `.wants` files
## thanks
this repository lives [here](https://git.ewy.one/pik/)
|
