# pardnchiu/PodRun

> PodRun by Pardn Chiu: a Go CLI that deploys compose projects to remote Podman, with k3s planned, as easily as local docker compose.

Maintained by 邱敬幃 Pardn Chiu (pardnchiu), Pardn Co., Ltd, Taiwan · Infrastructure Engineering. Source: https://github.com/pardnchiu/PodRun

Full text in one file: [English](https://podrun.pardn.io/llms-full.txt) · [中文](https://podrun.pardn.io/zh/llms-full.txt)

## Overview

- [Home](https://podrun.pardn.io/index.md): PodRun by Pardn Chiu: a Go CLI that deploys compose projects to remote Podman, with k3s planned, as easily as local docker compose.
- [Getting Started](https://podrun.pardn.io/getting-started.md): Build PodRun, set the SSH connection in .env, start the API server, and deploy your first compose project with podrun up.
- [Implementation Status](https://podrun.pardn.io/roadmap.md): What PodRun supports today and what is unfinished: k3s runtime, Kubernetes deploy, export, domain, info, and clone.

## Concepts

- [Architecture](https://podrun.pardn.io/architecture.md): How the PodRun CLI, the remote Podman host, and the local Gin + SQLite API server fit together.
- [Core Concepts](https://podrun.pardn.io/core-concepts.md): How PodRun derives the deployment UID, remote folder, and local project folder, and how commands are dispatched.

## Deploy Flow

- [File Sync](https://podrun.pardn.io/file-sync.md): How podrun up syncs files with rsync, previews diffs before overwriting, and which paths are excluded.
- [Compose Rewrite](https://podrun.pardn.io/compose-rewrite.md): How PodRun builds docker-compose.podrun.yml on the remote host by stripping host ports and adding SELinux :z labels.
- [Deployment Records](https://podrun.pardn.io/deployment-records.md): What the PodRun CLI reports to the API server, the record types, and how the dismiss flag changes.

## Reference

- [Configuration](https://podrun.pardn.io/configuration.md): Every PodRun environment variable, .env loading rules, DB_PATH defaults, and hard-coded values.
- [CLI Reference](https://podrun.pardn.io/cli-reference.md): All podrun commands and flags, including passthrough to podman compose and unfinished --type=k3s.
- [HTTP API](https://podrun.pardn.io/http-api.md): PodRun API server endpoints under /api/pod, Pod and Record fields, and the SQLite table schema.

## 中文文件

- [首頁](https://podrun.pardn.io/zh/index.md): 邱敬幃開發的 PodRun：Go CLI，像本地 docker compose 一樣部署到遠端 Podman，k3s 規劃中。
- [快速開始](https://podrun.pardn.io/zh/getting-started.md): 編譯 PodRun、在 .env 設定 SSH 連線、啟動 API Server，並以 podrun up 完成第一次部署。
- [實作狀態](https://podrun.pardn.io/zh/roadmap.md): PodRun 目前支援的功能與未完成項目：k3s、Kubernetes 部署、export、domain、info、clone。
- [架構](https://podrun.pardn.io/zh/architecture.md): PodRun 的 CLI、遠端 Podman 主機與本地 Gin + SQLite API Server 如何協作。
- [核心概念](https://podrun.pardn.io/zh/core-concepts.md): PodRun 如何推導部署 UID、遠端目錄與本地專案目錄，以及指令如何分派。
- [檔案同步](https://podrun.pardn.io/zh/file-sync.md): podrun up 如何以 rsync 同步、覆寫前預覽差異，以及排除哪些路徑。
- [Compose 改寫](https://podrun.pardn.io/zh/compose-rewrite.md): PodRun 如何在遠端產生 docker-compose.podrun.yml，移除主機 Port 並補 SELinux :z。
- [部署紀錄](https://podrun.pardn.io/zh/deployment-records.md): PodRun CLI 回報給 API Server 的內容、紀錄類型與 dismiss 旗標轉換。
- [設定](https://podrun.pardn.io/zh/configuration.md): PodRun 所有環境變數、.env 載入規則、DB_PATH 預設值與寫死的固定值。
- [命令列參考](https://podrun.pardn.io/zh/cli-reference.md): podrun 所有指令與旗標，含轉送 podman compose 與未完成的 --type=k3s。
- [HTTP API](https://podrun.pardn.io/zh/http-api.md): PodRun API Server 的 /api/pod 端點、Pod 與 Record 欄位及 SQLite 資料表。

## Optional

- [Release Notes](https://podrun.pardn.io/released/index.md): pardnchiu/PodRun changelog by version