Pandore/homarr
Public Access
1
0 Fork 0
Code Actions Activity

docs(dev): explain local PR preference

Browse Source
This commit is contained in:
Thomas Camlong committed 2026-08-02 08:19:45 +02:00
1 parent db6aa0b26e
commit ca7e50fb96
2 files changed
+6 -3
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

apps/docs/docs/advanced/command-line/development/index.mdx
+3 -1
View File
@@ -10,7 +10,9 @@ To install an optional `homarr` binary, run `pnpm dev:cli:install` and make your
pnpm dev:cli --
```
The main screen combines local `homarr:*` images with open pull requests and their GHCR preview status. Select an image to start or stop it, use `R` to build a remote pull request locally or rebuild a local image, or use `p` to pull a remote preview. Press `d` to switch to the instance dashboard and `d` again to return without losing the browser state. The explicit `dev` and `dash` subcommands start on either screen.
The main screen combines local `homarr:*` images with open pull requests and their GHCR preview status. Select an image to start or stop it, use `R` to build a remote pull request locally in the background or rebuild a local image, or use `p` to force a remote preview pull. Press `d` to switch to the instance dashboard and `d` again to return without losing the browser state. The explicit `dev` and `dash` subcommands start on either screen.
A locally built PR image is folded into its remote PR row only when its recorded revision exactly matches the current GitHub head SHA. The row is marked `◆ local`, and starting it prefers that local image without a registry pull. Outdated local builds remain separate rows. Navigation and dashboard switching remain available during background builds.
## Build images
tools/homarr-dev/README.md
+3 -2
View File
@@ -66,8 +66,8 @@ homarr doctor Check Docker and optional CLI integrations
```text
/ Filter by PR number, title, author, branch, CI, image, state, or port
↑/↓ or j/k Select
Enter or Space Pull latest image and start, or stop when already running
R Build a remote PR locally or rebuild a local image
Enter or Space Start the matching local build, otherwise pull remote; stop when running
R Build a remote PR locally in the background or rebuild a local image
p Pull a remote PR image and redeploy, preserving port and volume
m Toggle demo mode for the next launch
o Open PR on GitHub
@@ -82,6 +82,7 @@ q Quit; during a pull, cancel it
```
Pull progress, layer completion, local build provenance, selected PR details, CI state, image availability, inline logs, and the final port remain inside the TUI.
Local PR images are folded into their remote PR row only when the recorded revision exactly matches the current GitHub head SHA. They are marked `◆ local` and preferred by Enter; outdated builds remain separate local rows. Navigation and the `d` dashboard toggle remain available while a local build runs.
## Instance Dashboard