docs: add new ADR identifying a new TUI crate for setup command by turmelclem · Pull Request #3631 · IntersectMBO/mithril

turmelclem · 2026-10-15T09:02:34Z

Content

Introduce a new ADR file that identify a TUI crate that will be used for the one command setup signer

Pre-submit checklist

Branch
- Tests are provided (if possible)
- Crates versions are updated (if relevant)
- CHANGELOG file is updated (if relevant)
- Commit sequence broadly makes sense
- Key commits have useful messages
PR
- All check jobs of the CI have succeeded
- Self-reviewed the diff
- Useful pull request description
- Reviewer requested
Documentation
- Update README file (if relevant)
- Update documentation website (if relevant)
- Add dev blog post (if relevant)
- Add ADR blog post or Dev ADR entry (if relevant)
- No new TODOs introduced

Issue(s)

this PR relates to #3618

github-actions · 2026-10-15T09:17:25Z

Test Results

5 files ±0 226 suites ±0 1h 3m 5s ⏱️ + 15m 50s
4 011 tests ±0 4 011 ✅ ±0 0 💤 ±0 0 ❌ ±0
12 674 runs ±0 12 674 ✅ ±0 0 💤 ±0 0 ❌ ±0

Results for commit 9580147. ± Comparison against base commit e85df3d.

♻️ This comment has been updated with latest results.

Copilot

🟡 Changes recommended

The ADR lacks required comparison evidence and contains a filename typo.

2 open findings

What changed in this PR

Adds ADR 014 documenting the selection of Ratatui with Crossterm for the signer setup TUI.

Changes:

Defines TUI requirements and compares candidate crates.
Records the selected implementation and its consequences.

File	Summary
`docs/website/adr/014-indentify-a-TUI-crate-for-setup-command.md`	Adds the TUI selection ADR; requires filename correction and missing evaluation evidence.

🧠 Review effort: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

jpraynaud

LGTM 👍

Alenar

LGTM, but I feel that this ADR is quite lacking for a decision making:

only one table to compare the crates
no code sample to compare the crates
I think a focus on easy of use / implementation complexity is missing
Anyhow I think that Ratatui would have won even with all of those given it provide much more features.

jpraynaud · 2026-10-16T15:45:54Z

+---
+slug: 14
+title: |
+  14. Choosing a TUI crate for setup command


suggestion: The title and the filename disagree ("Choosing" vs "identify"). All other ADR filenames are lowercase, so the file could be renamed 014-choose-a-tui-crate-for-signer-setup-command.md.

Suggested change

14. Choosing a TUI crate for setup command

14. Choose a TUI crate for the signer setup command

jpraynaud · 2026-10-16T15:46:16Z

+  14. Choosing a TUI crate for setup command
+authors:
+  - name: Mithril Team
+tags: [Proposed]


question: All the existing ADRs are merged as Accepted or Superseded. Since this PR is approved, should the tag and the Status section switch to Accepted before merge? Also, the second commit Update ADR 14 with more criteria... does not follow the commit convention, so it could be squashed into the first one.

jpraynaud · 2026-10-16T15:46:37Z

+
+## Context
+
+With the goal of increasing Mithril adoption, we want to simplify the installation of the Mithril Signer for SPOs.


nit: Use lowercase "signer" consistently, as in the next line.

Suggested change

With the goal of increasing Mithril adoption, we want to simplify the installation of the Mithril Signer for SPOs.

With the goal of increasing Mithril adoption, we want to simplify the installation of the Mithril signer for SPOs.

jpraynaud · 2026-10-16T15:46:56Z

+
+#### Types of inputs
+
+Two interaction modes were considered:


suggestion: The Q&A mode requirements are listed but the decision only keeps the grid edit mode. Could you add a sentence explaining why the Q&A mode was discarded? Otherwise these requirements read as unmet.

jpraynaud · 2026-10-16T15:49:02Z

+- Downloads¹: 59 106 231
+- Size²: 70.7 + 18.4 KiB
+- Dependencies³: 207 (including color-eyre)
+- Testable: ✅ [UI output unit test](https://ratatui.rs/tutorials/counter-app/basic-app/#testing-the-ui-output)


Line 65
suggestion: The decision mentions TestBackend, so it would be clearer to link its documentation here too.

Suggested change

- Testable: ✅ [UI output unit test](https://ratatui.rs/tutorials/counter-app/basic-app/#testing-the-ui-output)

- Testable: ✅ [UI output unit test](https://ratatui.rs/tutorials/counter-app/basic-app/#testing-the-ui-output) with [`TestBackend`](https://docs.rs/ratatui/latest/ratatui/backend/struct.TestBackend.html)

jpraynaud · 2026-10-16T15:49:15Z

+- Dependencies³: 207 (including color-eyre)
+- Testable: ✅ [UI output unit test](https://ratatui.rs/tutorials/counter-app/basic-app/#testing-the-ui-output)
+- Q&A mode: ✅
+- Grid edit mode: ✅ Offer widgets Row and Cell structure to design tables


nit: Grammar.

Suggested change

- Grid edit mode: ✅ Offer widgets Row and Cell structure to design tables

- Grid edit mode: ✅ offers `Row` and `Cell` widgets to design tables

jpraynaud · 2026-10-16T15:50:26Z

+- Q&A mode: ✅
+- Grid edit mode: ✅ Offer widgets Row and Cell structure to design tables
+- Mouse support: ✅
+- Ease of development : **Medium**. Lot of things are possible with Ratatui so it offer a lot of options and can bring complexity. ([Q&A Prototype](https://github.com/IntersectMBO/mithril/blob/ctl/3618-identify-a-TUI-crate-for-setup-command/ratatui-question-answer/src/main.rs), [Grid Edit Prototype](https://github.com/IntersectMBO/mithril/blob/ctl/3618-identify-a-TUI-crate-for-setup-command/ratatui-grid-edit-mode/src/main.rs))


issue: The prototype links point to the ctl/3618-identify-a-TUI-crate-for-setup-command branch, so they will break once the branch is deleted.

jpraynaud · 2026-10-16T15:51:17Z

+
+## Consequences
+
+- The dependency footprint is significantly larger (~200 crates vs ~10-20 for prompt-based crates).


issue: The numbers do not match the comparison above. Please update them once the Ratatui count is measured without color-eyre.

jpraynaud · 2026-10-16T15:51:41Z

+
+- The dependency footprint is significantly larger (~200 crates vs ~10-20 for prompt-based crates).
+- Input widgets (text, integer validation, defaults, selection) must be implemented or pulled from companion crates (e.g. `tui-input`).
+- UI rendering can be covered by unit tests using Ratatui's `TestBackend`.


suggestion: Add the consequence of the separate crate decision.

Suggested change

- UI rendering can be covered by unit tests using Ratatui's `TestBackend`.

- UI rendering can be covered by unit tests using Ratatui's `TestBackend`.

- A new binary must be built, packaged and distributed for the setup command.

turmelclem self-assigned this Oct 15, 2026

turmelclem requested review from Alenar, damrobi and jpraynaud as code owners October 15, 2026 09:02

turmelclem added the documentation 📖 Documentation to add/update label Oct 15, 2026

turmelclem force-pushed the ctl/3618-ADR-to-identify-a-TUI-crate-for-setup-command branch 2 times, most recently from ad7ad61 to dc20463 Compare October 15, 2026 09:05

jpraynaud requested a lite review from Copilot October 15, 2026 09:30

Copilot started reviewing on behalf of jpraynaud October 15, 2026 09:30

View session

Copilot AI reviewed Oct 15, 2026

View reviewed changes

Comment thread docs/website/adr/014-identify-a-TUI-crate-for-setup-command.md Outdated

Comment thread docs/website/adr/014-identify-a-TUI-crate-for-setup-command.md

jpraynaud approved these changes Oct 15, 2026

View reviewed changes

Comment thread docs/website/adr/014-identify-a-TUI-crate-for-setup-command.md

Comment thread docs/website/adr/014-identify-a-TUI-crate-for-setup-command.md

Comment thread docs/website/adr/014-identify-a-TUI-crate-for-setup-command.md

turmelclem force-pushed the ctl/3618-ADR-to-identify-a-TUI-crate-for-setup-command branch 2 times, most recently from 0a0c6cf to 63224ef Compare October 15, 2026 13:02

docs: add new ADR identifying a new TUI crate for setup command

6941deb

turmelclem force-pushed the ctl/3618-ADR-to-identify-a-TUI-crate-for-setup-command branch from 63224ef to 6941deb Compare October 15, 2026 13:03

turmelclem deployed to testing-2-preview October 15, 2026 13:22 — with GitHub Actions Active

turmelclem deployed to testing-preview October 15, 2026 13:22 — with GitHub Actions Active

Alenar approved these changes Oct 16, 2026

View reviewed changes

Update ADR 14 with more criteria and Crate sections instead of one table

9580147

turmelclem force-pushed the ctl/3618-ADR-to-identify-a-TUI-crate-for-setup-command branch from 7ca5e21 to 9580147 Compare October 16, 2026 14:25

turmelclem deployed to testing-2-preview October 16, 2026 14:43 — with GitHub Actions Active

turmelclem deployed to testing-preview October 16, 2026 14:43 — with GitHub Actions Active

jpraynaud reviewed Oct 16, 2026

View reviewed changes

	14. Choosing a TUI crate for setup command
	14. Choose a TUI crate for the signer setup command


		## Context

		With the goal of increasing Mithril adoption, we want to simplify the installation of the Mithril Signer for SPOs.

	- Testable: ✅ [UI output unit test](https://ratatui.rs/tutorials/counter-app/basic-app/#testing-the-ui-output)
	- Testable: ✅ [UI output unit test](https://ratatui.rs/tutorials/counter-app/basic-app/#testing-the-ui-output) with [`TestBackend`](https://docs.rs/ratatui/latest/ratatui/backend/struct.TestBackend.html)

	- Grid edit mode: ✅ Offer widgets Row and Cell structure to design tables
	- Grid edit mode: ✅ offers `Row` and `Cell` widgets to design tables


		## Consequences

		- The dependency footprint is significantly larger (~200 crates vs ~10-20 for prompt-based crates).

	- UI rendering can be covered by unit tests using Ratatui's `TestBackend`.
	- UI rendering can be covered by unit tests using Ratatui's `TestBackend`.
	- A new binary must be built, packaged and distributed for the setup command.

Conversation

turmelclem commented Oct 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Content

Pre-submit checklist

Issue(s)

Uh oh!

github-actions Bot commented Oct 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

jpraynaud left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Alenar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This branch was successfully deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

turmelclem commented Oct 15, 2026 •

edited

Loading

github-actions Bot commented Oct 15, 2026 •

edited

Loading