Citadel app CLI

This is a new tool to parse, validate, and process Citadel app.yml and app.yml.jinja files, and also Umbrel apps which consist of a docker-compose.yml and an umbrel-app.yml file.

It is a low-level parser for app formats and not intended to be used directly by users.

However, it can be quite useful for developers who want to validate their app.yml files or port their app from Umbrel.

Getting started

🛈 To compile this app, you need to have Rust installed. You can find a guide on how to install Rust here.

Building a developer version

To build a version for development, run the following command:

cargo build --bin app-cli --release --all-features

Building a user version

If you are planning to actually use this CLI during development, you should rather use a developer version. The user build disables some features to reduce the size of the binary.

To compile the CLI in a minimal version, like the one we ship to end users, run:

cargo build --bin app-cli --release --features=cli,preprocess,umbrel

Subcommands

Run app-cli help to see a list of available subcommands and their usage.