# pibootctl

pibootctl is a utility for querying and manipulating the boot configuration of a Raspberry Pi. It is a relatively low level utility, and not intended to be as friendly (or as widely applicable) as `raspi-config`. It provides a command line interface only, but does attempt to be useful as a basis for more advanced interfaces (by providing input and output in human-readable, shell-interpretable, JSON, or YAML formats) as well as being useful in its own right.

The design philosophy of the utility is as follows:

1. Be safe: the utility manipulates the boot configuration and it’s entirely possible to create a non-booting system as a result. To that end, if no backup of the current boot configuration exists, always take one before manipulating it.

2. Be accessible: the Pi’s boot configuration lives on a FAT partition and is a simple ASCII text file. This means it can be read and manipulated by almost any platform (Windows, Mac OS, etc). Any backups of the configuration should be as accessible. To that end we use simple PKZIP files to store backups of boot configurations (in their original format), and place them on the same FAT partition as the configuration.

3. Be extensible: Almost all commands should default to human readable input and output, but options should be provided for I/O in JSON, YAML, and a shell-parseable format.

## Links

- The code is licensed under the GPL v3 or above

- The source code can be obtained from GitHub, which also hosts the bug tracker

- The documentation (which includes installation and quick start examples) can be read on ReadTheDocs

- Packages can be downloaded from PyPI, although reading the installation instructions will probably be more useful

## Contents

- Installation
  - Configuration
- User Manual
  - diff
  - get
  - help
  - list
  - load
  - remove
  - rename
  - save
  - set
  - show
  - status
- Development
  - Building the docs
  - Test suite
- API
  - pibootctl.exc
  - pibootctl.files
  - pibootctl.formatter
  - pibootctl.info
  - pibootctl.main
  - pibootctl.parser
  - pibootctl.setting
  - pibootctl.settings
  - pibootctl.store
  - pibootctl.term
  - pibootctl.userstr
- Changelog
  - Release 0.5.2 (2020-09-14)
  - Release 0.5.1 (2020-09-09)
  - Release 0.4 (2020-03-31)
  - Release 0.3 (2020-03-27)
  - Release 0.2 (2020-03-26)
  - Release 0.1.1 (2020-03-13)
  - Release 0.1 (2020-03-13)
- License

## Indexes

- Index

- Search Page