# FlatImage

* Author: [`@ruanformigoni`](https://github.com/ruanformigoni)
* Project Page: <https://github.com/ruanformigoni/flatimage>
* Detailed Docs: <https://flatimage.github.io/docs/>

***

### Schema

{% hint style="info" %}
[<mark style="color:purple;">**`.pkg`**</mark>](/sbuild/specification/2.pkg.md): <mark style="color:orange;">**`${PKG_NAME}-${BASE_DISTRO_IMAGE}`**</mark>

[<mark style="color:purple;">**`.pkg_type`**</mark>](/sbuild/specification/2.pkg.md): <mark style="color:green;">**`flatimage`**</mark>

<mark style="color:blue;">**`${SBUILD_PKG}`**</mark> : <mark style="color:green;">**`${PKG_NAME}-${BASE_DISTRO_IMAGE}.flatimage`**</mark>

{% code overflow="wrap" %}

```bash
!#Examples
firefox-alpine.FlatImage --> Created using alpine as base BaseImage/RootFS
steam-cachyos.FlatImage --> Created using CachyOs as BaseImage/RootFS
librewolf-alpine-nix.FlatImage --> Created using alpine as BaseImage/RootFS with Nix on top of it
```

{% endcode %}
{% endhint %}

***

### **Prerequisites (`HOST)`**

{% hint style="info" %}

* [**Fuse**](broken://pages/8hHKbF95BBtvZUMBe4k9): Required for mounting Filesystems & Images
* [**Fonts**](broken://pages/1Jy4S9xshgEUK6bIc0fl): Required to display/render Non-English Chars, Emojis, Symbols etc.
* [<mark style="color:blue;">**Kernel User NameSpaces**</mark>](broken://pages/tjmP70tpwiHVQQutUXFd): Required for Sandboxing, Security & Performance
  {% endhint %}

***

### Sandbox

{% hint style="success" %}
FlatImages have built-in sandboxing, check docs: <https://flatimage.github.io/docs/cmd/perms/>
{% endhint %}

***

### Quirks

{% hint style="info" %} <mark style="color:red;">**WARNINGS**</mark>

* NEVER run **`strip`**, **`objcopy`** or any other binary rewriting tool as they will often just strip the **`squashfs|dwarfs`** archive, only preserving the **`runtime`**.
* A typical <mark style="color:green;">**`.flatimage`**</mark> file is not a real elf binary, thus will not survive this process.
  {% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.pkgforge.dev/formats/packages/flatimage.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.