https://github.com/bibermann/just-kit-bibermann
https://github.com/bibermann/just-kit-bibermann
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bibermann/just-kit-bibermann
- Owner: bibermann
- Created: 2025-07-11T12:41:13.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-11-21T17:00:18.000Z (8 months ago)
- Last Synced: 2025-11-21T19:05:36.609Z (8 months ago)
- Language: Shell
- Size: 67.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# just-kit by Fabian
## Usage
### Prerequisites
#### [just-kit](https://github.com/bibermann/just-kit)
Clone to a proper location, e.g.:
```bash
git clone https://github.com/bibermann/just-kit ~/.just/kit
```
#### Naming
- With _this project_ I refer to the project containing this README.
- With _example project_ I refer to your project where you want to enable the tools.
### Setup
Clone _this project_ to a proper location, e.g.:
```bash
git clone https://github.com/bibermann/just-kit-bibermann ~/.just/bibermann
```
#### Enhance an _example project_
1. If the project roots of _just-kit_ or _this project_ are not within a `.just` directory
in one of the _example project_'s parent directories, add the following line
to the `.env` file in the _example project_ root
(replace with proper paths or skip paths already in proper parent directories):
```bash
EXTRA_JUST_ROOTS=":"
```
2. In an _example project_'s root, run `/link`, e.g. `~/.just/kit/link`.
3. Select and confirm all `*.just` files you want to use from within the _example project_.
Hints:
- To update the selection, run `just pick`.
- To enhance your bash session, run `source just-bash` (this is not permanent).
## Development
### Prerequisites
#### just-kit
Read and understand the _just-kit_ README.
### How to extend
Instead of contributing to this project, you may create your own recipes,
eventually replacing a `*.just` file in this project with your version
by simply switching through `just pick`.
### Setup for development
1. If the project root of _just-kit_ is not within a `.just` directory
in one of _this project_'s parent directories, add the following line
to the `.env` file in _this project_'s root
(replace `` with the _just-kit_ repository location):
```bash
EXTRA_JUST_ROOTS=""
```
2. In _this project_'s root, run `/link`, e.g. `~/.just/kit/link`.
3. Run `just _install-pre-commit` (or `just pre-commit` which will also run pre-commit).