feat(linux): implement diagnostic report by ermshiperete · Pull Request #15576 · keymanapp/keyman

ermshiperete · 2026-02-11T19:16:17Z

This change allows to collect data for a diagnostic report. This can be done either from the command line through the new km-diag-report tool, or in km-config from the new Support tab that allows to generate the report and then copy it to the clipboard or save as a file.

The diagnostic report contains installed browsers and their versions and installation methods as well as the default browser. It checks for browsers installed through apt (Ubuntu/Debian), snap, and flatpak.

The change also has an implementation for pacman (Arch Linux) and dnf/yum (Fedora), although these have not been tested.

Sample report

============================================================
Keyman for Linux Diagnostic Report (2026-02-26)
============================================================

--- Keyman Version ---
  Version: 19.0.202-alpha-local
  Tier: alpha
  Package version: (local)
  Installed package (dpkg): 19.0.204-1+noble1

--- IBus ---
  IBus version: 1.5.29-rc2 (Running)
  Preload engines: xkb:us::eng, xkb:de::deu, xkb:us::eng

--- Operating System ---
  OS: Ubuntu 24.04.4 LTS
  Codename: noble
  Kernel: 6.17.0-14-generic
  Architecture: x86_64

--- Display Server ---
  Session type: x11
  X11 display: :0

--- Desktop Environment ---
  Current desktop: ubuntu:GNOME
  Session desktop: ubuntu-xorg
  Desktop session: ubuntu-xorg

--- Input Method Configuration ---
  GTK_IM_MODULE: Not set
  QT_IM_MODULE: ibus
  XMODIFIERS: @im=ibus

--- Gnome Input Sources ---
  xkb: us
  xkb: de
  ibus: km:/home/user/.local/share/keyman/khmer_angkor/khmer_angkor.kmx
  ibus: bbc-Batk:/home/user/.local/share/keyman/batak/batak.kmx
  ibus: am:/home/user/.local/share/keyman/gff_amharic/gff_amharic.kmx
  ibus: dyo:/home/user/.local/share/keyman/kreative_superlatin/kreative_superlatin.kmx
  ibus: en:/home/user/.local/share/keyman/baseline/k_0108___rtl.kmx

--- Installed Keyman Keyboards ---
  User keyboards:
    - SIL Ethiopic Power-G (id: sil_ethiopic_power_g, version: 1.2.2)
    - EuroLatin (SIL) (id: sil_euro_latin, version: 2.0.1)
    - Korean KORDA Jamo (SIL) (id: sil_korda_jamo, version: 3.0.1)
    - Text Selection Tests Keyboard (id: text_selection_tests_keyboard, version: 1.0)
    - Lao Basic (id: basic_kbdlao, version: 1.1)
    - IPA (SIL) (id: sil_ipa, version: 1.8.6)
    - GFF Amharic (id: gff_amharic, version: 3.3)
    - Extra_English (id: extra_english, version: 1.0)
    - 0108 - rtl (id: baseline, version: 1.0)
    - German Basic (id: basic_kbdgr, version: 1.1)
    - None (id: test_kmx, version: None)
    - Vedic Sanskrit Devanagari Phonetic (ITRANS) (id: itrans_devanagari_sanskrit_vedic, version: 1.2.1)
    - Khmer Angkor (id: khmer_angkor, version: 2.2)
    - GFF Geʾez Manuscript Keyboard (id: gff_geez_emufi, version: 1.0.1)
    - US Basic (id: basic_kbdus, version: 1.2)
    - Myanmar3 (SIL) (id: sil_myanmar_my3, version: 1.7.3)
    - SENĆOŦEN (id: fv_sencoten, version: 9.2.3)
    - Kreative SuperLatin (id: kreative_superlatin, version: 1.1.1)
    - Batak (id: batak, version: 1.0.1)

--- Web Browsers ---
  APT packages:
    - firefox: 147.0.4~build1
    - chromium-browser: 1:85.0.4183.83-0ubuntu2.22.04.1
    - google-chrome-stable: 145.0.7632.109-1
  Snap packages:
    - chromium: 145.0.7632.109            (3369) 189MB -
  Default browser:
    /home/user/.local/share/applications/userapp-Firefox-3EVMT2.desktop (/usr/lib/firefox/firefox-bin)

============================================================
End of Diagnostic Report
============================================================

Fixes: #7784

User Testing

The tests should be run on these Linux versions:

GROUP_JAMMY_X11: Ubuntu 22.04 Jammy with Gnome Shell and X11
GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland
GROUP_NOBLE: Ubuntu 24.04 Noble (or later version) with Gnome Shell and Wayland
GROUP_WASTA: Wasta with Cinnamon

Tests

TEST_CLI: run km-diag-report and verify the output
TEST_UI: run km-config, switch to "Support" tab, generate the report and verify the output. Also try "Copy to Clipboard" and "Save to File" buttons.

keymanapp-test-bot · 2026-02-11T19:16:25Z

User Test Results

Test specification and instructions

✅ GROUP_JAMMY_X11: Ubuntu 22.04 Jammy with Gnome Shell and X11
2 tests PASSED
- ✅ TEST_CLI (PASSED) (notes)
- ✅ TEST_UI (PASSED) (notes)
✅ GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland
2 tests PASSED
- ✅ TEST_CLI (PASSED) (notes)
- ✅ TEST_UI (PASSED) (notes)
✅ GROUP_NOBLE: Ubuntu 24.04 Noble (or later version) with Gnome Shell and Wayland
2 tests PASSED
- ✅ TEST_CLI (PASSED) (notes)
- ✅ TEST_UI (PASSED) (notes)
⬜ GROUP_WASTA: Wasta with Cinnamon
- ⬜ TEST_CLI (OPEN)
- ⬜ TEST_UI (OPEN)

Results Template

# Test Results

### GROUP_WASTA: Wasta with Cinnamon

* **TEST_CLI (OPEN):** notes
* **TEST_UI (OPEN):** notes

This change allows to collect data for a diagnostic report. This can be done either from the command line through the new `km-diag-report` tool, or in `km-config` from the new `Support` tab that allows to generate the report and then copy it to the clipboard or save as a file. The diagnostic report contains installed browsers and their versions and installation methods as well as the default browser. It checks for browsers installed through apt (Ubuntu/Debian), snap, and flatpak. The change also has an implementation for pacman (Arch Linux) and dnf/yum (Fedora), although these have not been tested. Fixes: #7784

mcdurdin · 2026-02-16T08:17:29Z

@kingsuper195 will take a look on Arch Linux:

fetch feat/linux/7784_diagreport branch,

build with linux/keyman-config/build.sh

and then run the diag report with linux/keyman-config/km-diag-report. This will output a diagnostic report.

Check that the section about the installed web browsers is correct and complete.

As a bonus paste the report in a comment.

kingsuper195 · 2026-02-17T18:28:38Z

Arch Linux:

============================================================
Keyman Diagnostic Report
============================================================

--- Keyman Version ---
  Version: 19.0.202-alpha-local
  Tier: alpha
  Package version: 18.0.236

--- IBus ---
  IBus version: 1.5.33

--- Operating System ---
  OS: Arch Linux
  Kernel: 6.12.73-1-lts
  Architecture: x86_64

--- Display Server ---
  Session type: wayland
  Wayland display: wayland-0
  X11 display: :0

--- Desktop Environment ---
  Current desktop: GNOME
  Session desktop: gnome
  Desktop session: gnome

--- Input Method Configuration ---
  GTK_IM_MODULE: Not set
  QT_IM_MODULE: ibus
  XMODIFIERS: @im=ibus

--- Gnome Input Sources ---
  xkb: us

--- Installed Keyman Keyboards ---
No Keyman keyboards installed

--- Web Browsers ---
No Firefox, Chromium, or Chrome installations found
  Default browser:
    /usr/share/applications/org.gnome.Epiphany.desktop (epiphany)

============================================================
End of Diagnostic Report
============================================================

darcywong00 · 2026-02-26T01:58:08Z

I ran GROUP_NOBLE with the Ubuntu Packaging build

GROUP_NOBLE

TEST_CLI: pass

============================================================
Keyman Diagnostic Report
============================================================

--- Keyman Version ---
  Version: 19.0.202-alpha
  Tier: alpha
  Package version: 19.0.202-1~PR-15576-6771.1+noble1
  Installed package (dpkg): 19.0.202-1~PR-15576-6771.1+noble1

--- IBus ---
  IBus version: 1.5.29-rc2
  Preload engines: xkb:us::eng

--- Operating System ---
  OS: Pop!_OS 24.04 LTS
  Codename: noble
  Kernel: 6.18.7-76061807-generic
  Architecture: x86_64

--- Display Server ---
  Session type: wayland
  Wayland display: wayland-1
  X11 display: :1

--- Desktop Environment ---
  Current desktop: COSMIC
  Session desktop: COSMIC

--- Input Method Configuration ---
  GTK_IM_MODULE: ibus
  QT_IM_MODULE: ibus
  XMODIFIERS: @im=ibus

--- Installed Keyman Keyboards ---
  User keyboards:
    - IPA (SIL) (id: sil_ipa, version: 1.8.6)
    - Arabic Phonetic (SIL) (id: sil_arabic_phonetic, version: 1.1)

--- Web Browsers ---
  APT packages:
    - firefox: 1:148.0~1771957609~24.04~92b7f0e
    - google-chrome-stable: 145.0.7632.116-1
  Default browser:
    /usr/share/applications/google-chrome.desktop (/usr/bin/google-chrome-stable)

============================================================
End of Diagnostic Report
============================================================

TEST_UI: pass
Was able to "Generate Report"

Copy to Clipboard

============================================================
Keyman Diagnostic Report
============================================================

--- Keyman Version ---
  Version: 19.0.202-alpha
  Tier: alpha
  Package version: 19.0.202-1~PR-15576-6771.1+noble1
  Installed package (dpkg): 19.0.202-1~PR-15576-6771.1+noble1

--- IBus ---
  IBus version: 1.5.29-rc2
  Preload engines: xkb:us::eng

--- Operating System ---
  OS: Pop!_OS 24.04 LTS
  Codename: noble
  Kernel: 6.18.7-76061807-generic
  Architecture: x86_64

--- Display Server ---
  Session type: wayland
  Wayland display: wayland-1
  X11 display: :1

--- Desktop Environment ---
  Current desktop: COSMIC
  Session desktop: COSMIC

--- Input Method Configuration ---
  GTK_IM_MODULE: ibus
  QT_IM_MODULE: ibus
  XMODIFIERS: @im=ibus

--- Installed Keyman Keyboards ---
  User keyboards:
    - IPA (SIL) (id: sil_ipa, version: 1.8.6)
    - Arabic Phonetic (SIL) (id: sil_arabic_phonetic, version: 1.1)

--- Web Browsers ---
  APT packages:
    - firefox: 1:148.0~1771957609~24.04~92b7f0e
    - google-chrome-stable: 145.0.7632.116-1
  Default browser:
    /usr/share/applications/google-chrome.desktop (/usr/bin/google-chrome-stable)

============================================================
End of Diagnostic Report
============================================================

Save
keyman-diagnostic-report.txt
to File diagnostic report

darcywong00

looking good. a couple of questions

linux/keyman-config/keyman_config/diag_report.py

linux/keyman-config/keyman_config/support_widget.py

linux/keyman-config/keyman_config/diag_report.py

linux/keyman-config/keyman_config/ibus_util.py

Meng-Heng · 2026-02-26T10:11:05Z

Test Results

GROUP_JAMMY_X11: Ubuntu 22.04 Jammy with Gnome Shell and X11

TEST_CLI (PASSED):

Open Terminal
Run km-diag-report

Result:

============================================================
Keyman Diagnostic Report
============================================================

--- Keyman Version ---
  Version: 19.0.202-alpha
  Tier: alpha
  Package version: 19.0.202-1~PR-15576-6771.1+jammy1
  Installed package (dpkg): 19.0.202-1~PR-15576-6771.1+jammy1

--- IBus ---
  IBus version: 1.5.26

--- Operating System ---
  OS: Ubuntu 22.04.5 LTS
  Codename: jammy
  Kernel: 6.8.0-101-generic
  Architecture: x86_64

--- Display Server ---
  Session type: x11
  X11 display: :0

--- Desktop Environment ---
  Current desktop: ubuntu:GNOME
  Session desktop: ubuntu-xorg
  Desktop session: ubuntu-xorg

--- Input Method Configuration ---
  GTK_IM_MODULE: ibus
  QT_IM_MODULE: ibus
  XMODIFIERS: @im=ibus

--- Gnome Input Sources ---
  xkb: us
  ibus: km:/home/vboxuser/.local/share/keyman/basic_kbdkhmr/basic_kbdkhmr.kmx

--- Installed Keyman Keyboards ---
  User keyboards:
    - Khmer Basic (id: basic_kbdkhmr, version: 1.2.2)

--- Web Browsers ---
  APT packages:
    - firefox: 1:1snap1-0ubuntu2
  Snap packages:
    - firefox: 130.0-2                 (4848) 284MB -
  Default browser:
    /usr/share/applications/firefox.desktop (firefox)

============================================================
End of Diagnostic Report
============================================================

TEST_UI (PASSED):

Open Terminal
Run km-config
Go to Support tab
Result:
- Generate reports work
- Copy clipboard work
- Save files and upload to Google Drive work
  - keyman-diagnostic-report_Save_to_file_X11_Jammy.txt

GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland

TEST_CLI (PASSED):

Open Terminal
Run km-diag-report

Result:

============================================================
Keyman Diagnostic Report
============================================================

--- Keyman Version ---
  Version: 19.0.202-alpha
  Tier: alpha
  Package version: 19.0.202-1~PR-15576-6771.1+jammy1
  Installed package (dpkg): 19.0.202-1~PR-15576-6771.1+jammy1

--- IBus ---
  IBus version: 1.5.26

--- Operating System ---
  OS: Ubuntu 22.04.5 LTS
  Codename: jammy
  Kernel: 6.8.0-101-generic
  Architecture: x86_64

--- Display Server ---
  Session type: wayland
  Wayland display: wayland-0
  X11 display: :0

--- Desktop Environment ---
  Current desktop: ubuntu:GNOME
  Session desktop: ubuntu
  Desktop session: ubuntu

--- Input Method Configuration ---
  GTK_IM_MODULE: Not set
  QT_IM_MODULE: ibus
  XMODIFIERS: @im=ibus

--- Gnome Input Sources ---
  xkb: us
  ibus: km:/home/vboxuser/.local/share/keyman/basic_kbdkhmr/basic_kbdkhmr.kmx

--- Installed Keyman Keyboards ---
  User keyboards:
    - Khmer Basic (id: basic_kbdkhmr, version: 1.2.2)

--- Web Browsers ---
  APT packages:
    - firefox: 1:1snap1-0ubuntu2
  Snap packages:
    - firefox: 130.0-2                 (4848) 284MB -
  Default browser:
    /usr/share/applications/firefox.desktop (firefox)

============================================================
End of Diagnostic Report
============================================================

TEST_UI (PASSED):

Open Terminal
Run km-config
Go to Support tab
Result:
- Generate reports work
- Copy clipboard work
- Save files and upload to Google Drive work
  - Diagnostic_JammyWayland_Configuration_tab.txt

- add date to header and filename - add state of ibus - add privacy statement and link to privacy policy

darcywong00

lgtm

github-project-automation bot added this to Keyman Feb 11, 2026

github-project-automation bot moved this to Todo in Keyman Feb 11, 2026

keymanapp-test-bot bot added the user-test-missing User tests have not yet been defined for the PR label Feb 11, 2026

github-actions bot added linux/ linux/config/ labels Feb 11, 2026

keymanapp-test-bot bot added this to the A19S22 milestone Feb 11, 2026

github-actions bot added the feat label Feb 11, 2026

refactor(linux): make get_ibus_version() public

c6e7337

ermshiperete force-pushed the feat/linux/7784_diagreport branch 3 times, most recently from 88beaac to 50961e4 Compare February 13, 2026 15:30

ermshiperete force-pushed the feat/linux/7784_diagreport branch from 50961e4 to cb1de97 Compare February 13, 2026 16:29

keyman-server modified the milestones: A19S22, A19S23 Feb 13, 2026

keymanapp-test-bot bot added has-user-test user-test-required User tests have not been completed and removed user-test-missing User tests have not yet been defined for the PR labels Feb 25, 2026

ermshiperete requested a review from mcdurdin February 25, 2026 11:07

ermshiperete marked this pull request as ready for review February 25, 2026 11:07

ermshiperete requested a review from darcywong00 February 25, 2026 11:08

darcywong00 reviewed Feb 26, 2026

View reviewed changes

Meng-Heng self-assigned this Feb 26, 2026

Meng-Heng removed their assignment Feb 26, 2026

ermshiperete requested a review from darcywong00 February 26, 2026 16:01

feat(linux): address code review comments

76866b2

- add date to header and filename - add state of ibus - add privacy statement and link to privacy policy

ermshiperete force-pushed the feat/linux/7784_diagreport branch from ef6fefd to 76866b2 Compare February 26, 2026 16:05

darcywong00 approved these changes Feb 27, 2026

View reviewed changes

keyman-server modified the milestones: A19S23, A19S24 Feb 27, 2026

Meng-Heng self-assigned this Mar 2, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(linux): implement diagnostic report#15576

feat(linux): implement diagnostic report#15576
ermshiperete wants to merge 3 commits intomasterfrom
feat/linux/7784_diagreport

ermshiperete commented Feb 11, 2026 •

edited

Loading

Uh oh!

keymanapp-test-bot bot commented Feb 11, 2026 •

edited

Loading

Uh oh!

mcdurdin commented Feb 16, 2026

Uh oh!

kingsuper195 commented Feb 17, 2026 •

edited by mcdurdin

Loading

Uh oh!

darcywong00 commented Feb 26, 2026

Uh oh!

darcywong00 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Meng-Heng commented Feb 26, 2026

Uh oh!

darcywong00 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Uh oh!

Conversation

ermshiperete commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Sample report

User Testing

Tests

Uh oh!

keymanapp-test-bot bot commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

User Test Results

Uh oh!

mcdurdin commented Feb 16, 2026

Uh oh!

kingsuper195 commented Feb 17, 2026 • edited by mcdurdin Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

darcywong00 commented Feb 26, 2026

GROUP_NOBLE

Uh oh!

darcywong00 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Meng-Heng commented Feb 26, 2026

Test Results

GROUP_JAMMY_X11: Ubuntu 22.04 Jammy with Gnome Shell and X11

GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland

Uh oh!

darcywong00 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ermshiperete commented Feb 11, 2026 •

edited

Loading

keymanapp-test-bot bot commented Feb 11, 2026 •

edited

Loading

kingsuper195 commented Feb 17, 2026 •

edited by mcdurdin

Loading