95 lines
3.1 KiB
Markdown
95 lines
3.1 KiB
Markdown
# Homarr Developer CLI
|
|
|
|
Build and launch local Homarr images and GHCR pull-request builds, then manage them from responsive terminal dashboards.
|
|
|
|
## Requirements
|
|
|
|
- Docker or OrbStack
|
|
- GitHub CLI authenticated with `gh auth login`
|
|
- Go 1.25+ to build from source
|
|
|
|
## Setup
|
|
|
|
```sh
|
|
pnpm dev:setup
|
|
```
|
|
|
|
This installs monorepo dependencies, creates and migrates the local SQLite database, starts or reuses Redis, installs `homarr` to `~/.local/bin`, and generates Fish completions when Fish is configured. Add `~/.local/bin` to `PATH` to invoke `homarr` directly; setup prints the absolute command when it is not available on `PATH`.
|
|
|
|
## Build
|
|
|
|
```sh
|
|
homarr build feature
|
|
homarr build --pr 6441
|
|
homarr rebuild feature
|
|
```
|
|
|
|
Checkout builds are tagged as `homarr:<name>`. The source checkout and revision are recorded on the image so `homarr rebuild` and the development dashboard can rebuild it later. PR builds use a temporary checkout and default to `homarr:pr-<number>`.
|
|
|
|
## Launch
|
|
|
|
```sh
|
|
homarr run dev
|
|
homarr run --detach dev
|
|
homarr run --pr 6441
|
|
homarr run --pr 6441 --demo
|
|
homarr run --env FOO=bar --env FEATURE=true dev
|
|
```
|
|
|
|
PR launches always pull the latest GHCR tag before starting. Local tags remain local.
|
|
|
|
## Commands
|
|
|
|
```text
|
|
homarr dash Interactive instance dashboard
|
|
homarr dev Interactive local and remote image browser
|
|
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
|
|
homarr list Script-friendly instance list
|
|
homarr logs <container> Follow logs
|
|
homarr open <container> Open in browser
|
|
homarr stop <container> Stop
|
|
homarr restart <container> Restart
|
|
homarr remove <container> Force-remove
|
|
homarr doctor Check Docker, GitHub auth, and PATH
|
|
```
|
|
|
|
## Development Browser
|
|
|
|
```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 Rebuild a local image from its checkout or PR
|
|
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
|
|
a Open running app
|
|
l Toggle inline logs for the selected running PR
|
|
f Follow or pause inline logs
|
|
Page Up/Down Scroll inline logs
|
|
b Show or hide bot PRs
|
|
r Refresh
|
|
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.
|
|
|
|
## Instance Dashboard
|
|
|
|
```text
|
|
/ Filter by name, image, state, health, port, or URL
|
|
↑/↓ or j/k Select
|
|
l Toggle inline logs
|
|
f Follow or pause logs
|
|
Page Up/Down Scroll logs
|
|
s Stop
|
|
R Restart
|
|
x Remove with confirmation
|
|
o Open in browser
|
|
c Copy URL
|
|
r Refresh
|
|
q Quit
|
|
```
|