diff options
| author | ewy <ewy0@protonmail.com> | 2026-04-14 19:10:24 +0200 |
|---|---|---|
| committer | ewy <ewy0@protonmail.com> | 2026-04-14 19:10:24 +0200 |
| commit | 4fd3756396bcdb6ecad4b2a836c68349e797004d (patch) | |
| tree | 1fa1bbf31e2554ace5ce258d97ce2723681a013d /README.md | |
| parent | 466758ce0a6de964f6ed8228d78fb7e9a4ff9a67 (diff) | |
update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 15 insertions, 2 deletions
@@ -9,10 +9,13 @@ pik 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 a supported repository will index its own file-based task system, as well as +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 @@ -32,7 +35,7 @@ running `pik` in a supported repository will index its own file-based task syste * 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 the first- or second line comment + * 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 @@ -43,6 +46,10 @@ running `pik` in a supported repository will index its own file-based task syste * 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 @@ -52,9 +59,15 @@ 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/)
\ No newline at end of file |