Overriding $TERM to a more compatible value like xterm-256color

[danterolle]

Hello everyone! I ran into a small compatibility issue when using the interactive UI. I’m using the Ghostty terminal emulator, and in this case the build process failed with a fatal error:

'xterm-ghostty': unknown terminal type.

I think this simple issue can affect users of modern terminal emulators such as Ghostty, Kitty, etc...

These terminals often set a TERM environment variable (e.g., xterm-ghostty, xterm-kitty) that is not included in the default terminfo database available inside the build environment. As a result, text‑based user interface (TUI) tools like dialog cannot render.

I think it is enough to just add a small note in the documentation, as indicated in the commit.

[coderabbitai]

Walkthrough

Adds two Troubleshooting sections to docs/Developer-Guide_Build-Preparation.md: one after the Interactive Run framework sample and one after the CLI sample. Both describe an "unknown terminal type" error when running ./compile.sh in some modern terminal emulators and provide a quick workaround by setting the TERM environment variable to xterm-256color before execution. No source code or APIs were changed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title succinctly captures the primary change — recommending overriding $TERM to a more compatible value such as xterm-256color — and directly reflects the documentation updates described in the PR (troubleshooting blocks and a quick workaround). It is concise, specific to the main issue, and free of noisy details or file lists. Therefore it meets the stated title criteria.
Description Check	✅ Passed	The description clearly explains the compatibility issue, reproduces the error message, and states why a documentation note is the appropriate fix, which matches the PR's changeset (adding troubleshooting blocks and a TERM workaround). It is directly related to the changes and provides sufficient context for this lenient check. Thus the description passes.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 45397b9 and 00d0ecc.

📒 Files selected for processing (1)

• docs/Developer-Guide_Build-Preparation.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/Developer-Guide_Build-Preparation.md

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/Developer-Guide_Build-Preparation.md (1)

71-78: Offer longer-term fixes (optional).

Consider adding a short note that installing matching terminfo entries also resolves this (e.g., kitty-terminfo, wezterm terminfo, tmux-256color) or using TERM=screen-256color when inside tmux/screen. Please verify package names for Ubuntu 24.04/Noble before merging.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8c253a0 and 45397b9.

📒 Files selected for processing (1)

• docs/Developer-Guide_Build-Preparation.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

docs/Developer-Guide_Build-Preparation.md

75-75: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

🔇 Additional comments (2)

docs/Developer-Guide_Build-Preparation.md (2)

71-78: AI summary says two troubleshooting blocks; only one is present here.

Confirm whether a second block (after the Interactive section) is still intended.

---

71-78: Good addition—addresses a real footgun.

Clear, helpful guidance for users hitting dialog/terminfo issues.