From 8c8a8809c12d736a8f7c1c97944755d175b8b786 Mon Sep 17 00:00:00 2001
From: a-kenji <aks.kenji@protonmail.com>
Date: Tue, 26 Mar 2024 18:47:25 +0100
Subject: [PATCH] documentation: add flatpak documentation

---
 formatter.nix                    |  4 ++++
 pkgs/clan-cli/flatpak/FLATPAK.md | 21 +++++++++++++++++++++
 2 files changed, 25 insertions(+)

diff --git a/formatter.nix b/formatter.nix
index 1e2e1c35d..dae5f1ea5 100644
--- a/formatter.nix
+++ b/formatter.nix
@@ -13,6 +13,10 @@
         "pkgs/clan-vm-manager".extraPythonPackages =
           self'.packages.clan-vm-manager.externalTestDeps ++ self'.packages.clan-cli.testDependencies;
       };
+      treefmt.settings.formatter.mypy.excludes = [
+        "*/flatpak-builder"
+        "*/build-dir"
+      ];
 
       treefmt.settings.formatter.nix = {
         command = "sh";
diff --git a/pkgs/clan-cli/flatpak/FLATPAK.md b/pkgs/clan-cli/flatpak/FLATPAK.md
index e69de29bb..9b2f2a629 100644
--- a/pkgs/clan-cli/flatpak/FLATPAK.md
+++ b/pkgs/clan-cli/flatpak/FLATPAK.md
@@ -0,0 +1,21 @@
+# Flatpak Documentation
+
+
+## Installing locally
+
+You can install the package locally through `flatpak-builder`:
+```sh
+flatpak-builder --user --install --force-clean build-dir org.clan.cli.yml
+```
+
+## Debugging
+
+```sh
+flatpak run --devel --command=sh org.clan.cli
+```
+
+Replace `org.clan.cli` with the desired identifier.
+Now you can run commands inside the sandbox, for example:
+```sh
+[📦 org.clan.cli clan-cli-flatpak]$ strace -f -o strace.log clan vms run syncthing-peer1
+```