docs(dev): document dashboard navigation

This commit is contained in:
Thomas Camlong committed 2026-08-01 23:49:23 +02:00
1 parent df587ec76a
commit 49a41431b9
2 files changed
+7 -4

No files matched your search

@@ -7,10 +7,10 @@ To install an optional `homarr` binary, run `pnpm dev:cli:install` and make your
## Browse development images
```bash
pnpm dev:cli -- dev
pnpm dev:cli --
```
The interactive browser 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.
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.
## Build images
+5 -2
View File
@@ -46,8 +46,9 @@ The command reference below assumes the optional `homarr` installation. Without
## Commands
```text
homarr dash Interactive instance dashboard
homarr dev Interactive local and remote image browser
homarr Interactive local and remote image browser
homarr dev Explicit alias for the main browser
homarr dash Start on the instance dashboard
homarr build <name> Build this checkout as homarr:<name>
homarr build --pr <number> Build a PR locally from a temporary checkout
homarr rebuild <name> Rebuild from recorded provenance
@@ -76,6 +77,7 @@ f Follow or pause inline logs
Page Up/Down Scroll inline logs
b Show or hide bot PRs
r Refresh
d Switch to the instance dashboard
q Quit; during a pull, cancel it
```
@@ -95,5 +97,6 @@ x Remove with confirmation
o Open in browser
c Copy URL
r Refresh
d Switch to the development browser
q Quit
```