parchlinux-mobile/kupferbootstrap
1
0
Fork 1
mirror of https://gitlab.com/kupfer/kupferbootstrap.git synced 2025-02-22 13:15:44 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
Package- and image building tool for Kupfer Linux. Documentation: https://kupfer.gitlab.io/kupferbootstrap
772 commits 25 branches 12 tags 1,019 KiB
Python 99.4%
Dockerfile 0.3%
Shell 0.3%
Find a file
Exact
raihan2000 041b2d7dc5 integration_tests.py: add kbs.main in import
2024-10-20 20:49:47 +05:30
.vscode Add formatting 2021-08-08 18:24:56 +02:00
docs docs: WIP 2024-10-07 20:01:17 +02:00
local/bin Dockerfile: clean up pkgconfig-aarch64 leftover 2022-11-09 19:39:59 +01:00
src/kupferbootstrap kbs.chroot.device: add cast to satisfy typecheker 2024-10-20 20:21:19 +05:30
.dockerignore fix docker wrapper 2024-10-07 20:01:17 +02:00
.gitignore kbs.chroot.device: add cast to satisfy typecheker 2024-10-20 20:21:19 +05:30
.gitlab-ci.yml gitlab-ci: add sanity check for docker images by running kbs --help 2024-10-07 20:01:17 +02:00
docker_version.txt fix docker wrapper 2024-10-07 20:01:17 +02:00
Dockerfile fix docker wrapper 2024-10-07 20:01:17 +02:00
format.sh move kbs libary files to src/ 2024-10-07 19:59:08 +02:00
integration_tests.py integration_tests.py: add kbs.main in import 2024-10-20 20:49:47 +05:30
LICENSE LICENSE: Add GPLv3 as was decided ages ago on Matrix. 2022-02-28 04:26:08 +01:00
pyproject.toml fix docker wrapper 2024-10-07 20:01:17 +02:00
pytest.sh make kupferbootstrap package installable 2024-10-07 20:01:17 +02:00
README.md fix docker wrapper 2024-10-07 20:01:17 +02:00
requirements.txt make kupferbootstrap package installable 2024-10-07 20:01:17 +02:00
setup.cfg Add formatting 2021-08-08 18:24:56 +02:00
test_requirements.txt test_requirements.txt: add formatters and mypy for easier development 2023-06-25 04:03:03 +02:00
tox.ini tox.ini: specify maximum line length 2022-08-08 02:49:16 +02:00
typecheck.sh typecheck: add --check-untyped-defs and fix some associated type errors 2022-11-09 20:19:04 +01:00
wrapper_su_helper.py fix docker wrapper 2024-10-07 20:01:17 +02:00

README.md

kupferbootstrap

Kupfer Linux bootstrapping tool - drives pacstrap, makepkg, chroot, mkfs and fastboot, just to name a few.

Documentation

Detailed docs for the main branch are available online at https://kupfer.gitlab.io/kupferbootstrap/

You can also build and view the docs locally:

cd docs/ && \
make && \
make serve

This will run a webserver on localhost:9999. Access it like firefox http://localhost:9999/

Installation

  1. If you're not on ArchLinux (i.e. don't have pacman, makepkg, etc. available in your $PATH), install Docker and add yourself to the docker group.
  2. Craate a python venv: python3 -m venv venv
  3. Activate it: source venv/bin/activate
  4. Install KBS: pip3 install .

Then run kupferbootstrap.

Pro Tip:

  • You can add a shell alias for $(PWD)/venv/bin/kupferbootstrap or create a symlink to it at /usr/local/bin/kuperbootstrap for quick access without needing to manually source the venv script every time.
  • It is recommended to abbreviate kupferbootstrap to kbs for even less typing.

Quickstart

  1. Initialize config with defaults, configure your device and flavour: kupferbootstrap config init
  2. Initialize PKGBUILDs and caches: kupferbootstrap packages init
  3. Build an image and packages along the way: kupferbootstrap image build

Development

Docker

Put BUILD (the default) into docker_version.txt to always rebuild kupferboostrap from this directory; otherwise the image is pulled from registry.gitlab.com/kupfer/kupferbootstrap:$VERSION, where $VERSION is the contents of docker_version.txt.