Skip to content

[docs] Document WithTerminal Columns/Rows validation #1479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
David Pine (IEvangelist) merged 3 commits into from
Aug 14, 2026
Merged

[docs] Document WithTerminal Columns/Rows validation #1479

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f655090
docs: note WithTerminal Columns/Rows validation
aspire-repo-bot[bot] Aug 12, 2026
707c5f1
Clarify terminal dimension validation wording
IEvangelist Aug 12, 2026
291217d
Merge branch 'release/13.5' into docs/pr-18992-31566159352-1-e5ffd026…
IEvangelist Aug 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/frontend/src/content/docs/app-host/with-terminal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,14 @@ The terminal session is described by a set of options with sensible defaults:

| Option | Default | Description |
| ------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Columns` | `120` | The initial number of columns for the terminal grid. |
| `Columns` | `120` (11 ) | The initial number of columns for the terminal grid. |
| `Rows` | `30` | The initial number of rows for the terminal grid. |
| `ShowTerminalHost` | `false` | Whether the hidden per-replica terminal host resources appear in the dashboard and CLI resource lists. Set to `true` to diagnose terminal-host startup or connectivity issues. |

<Aside type="tip">
`Columns` and `Rows` must each be `1` or greater. Configuring either with zero or a negative value in the `WithTerminal(...)` callback throws an `ArgumentOutOfRangeException` immediately instead of failing later during terminal-host startup.
</Aside>

<Aside type="note">
The resource being run is always the terminal program: for executables that's the process itself, and for containers it's the container's own process. There's no way to select a different shell to launch for the session—an earlier `Shell` option that appeared to do this was removed because it was never wired up to the underlying pseudo-terminal and had no effect.
</Aside>
Expand Down
Loading