Getting Started
AuriType (聆风) is a pinyin input method for Linux. It runs on IBus and draws its own candidate panel. This page covers installation through everyday typing; tuning, AI, keys, and diagnostics each have their own page.
- Changing scheme, correction or fuzzy pinyin: Pinyin Tuning
- Cloud suggestions and the API key: Optional AI Input
- Looking up a key: Keymap; when something breaks: Diagnostics and logs
1. Install and start typing
Section titled “1. Install and start typing”Install the combined package (recommended):
sudo apt install ./auritype_*.debibus restart # reload the engine so it picks up the new codeAdd 聆风拼音 (engine name auritype-pinyin) to your input sources. On GNOME, add it under Settings → Keyboard.
After the first install, log out and log back in once, so the caret-tracking extension loads. Otherwise the candidate panel may not sit next to the insertion point.
Use ibus restart after packaging or make dev-install. The daemon is supervised by the systemd user unit org.freedesktop.IBus.session.GNOME.service, which relaunches the engine and the panel; auritype-xim.service brings ibus-x11 back on its own. Run it from an ordinary terminal: CARGO_*, CURSOR_*, and VSCODE_* in an IDE or agent shell pass through the daemon to the engine. An extension script change needs logging out and back in to load.
Supported ranges, package formats, and checksums are on the Install page. Remove it: sudo apt remove --purge auritype
2. Interface
Section titled “2. Interface”- Composition: the pinyin you are typing. A space separates syllables. After a partial commit, the confirmed characters stay at the front and what follows is still pinyin.
- Candidate panel: row 1 is the best result for the whole input. Below it there may be whole sentences with different word choices, prefix words, or the first character. Picking a prefix or the first character confirms only that part; the remaining pinyin keeps composing.
- Segment edit:
Shift+←/→shrinks the current segment to a syllable boundary, and the candidates then cover only that segment. - Readings: a character you typed correctly, and an exact whole word, show no pinyin. Only a mistyped character may carry pinyin with tone marks, for example 「随(suí)时」.
3. Basic input
Section titled “3. Basic input”The default is full pinyin. Full pinyin already includes abbreviated pinyin (nh → 「你好」, bj → 「北京」), so there is no switch for it.
| Action | Keys |
|---|---|
| Pick a candidate | Number keys 1–9, 0 |
| Commit | Space: commits the whole sentence when you have not edited a segment and focus is on row 1, otherwise commits the focused candidate |
| Commit the raw pinyin | Enter (keeps your capitalization) |
| Cancel the composition | Esc (clears it); Ctrl+C also works while composing |
| Page | PageUp / PageDown; - / = also work by default (changeable in settings) |
| Move candidate focus | ← / → |
| Move the caret by syllable | Ctrl+← / Ctrl+→ |
| Edit a segment | Shift+← / Shift+→ |
| Syllable break | ' (for example xi'an → 「西安」) |
Punctuation: while composing, the current candidate or the whole sentence commits first, then the symbol is output. \ gives the enumeration comma 、.
Email and URLs: press @ while composing, or type www then ., or type http/https/ftp/file/mailto then :, or a drive path C:\ (type C then :). In these spots the pinyin before the marker is not converted to characters — instead the input switches to raw half-width until Space/Enter commits the whole run or Esc discards it. So in Chinese mode you can type zhangsan@example.com, dev@163.com, https://a.b/?x=1, and C:\Users in one go: the . does not become 「。」 and digits are not treated as selection keys.
After @ you get domain completions (@qq.com, @163.com, @gmail.com…; keep typing to filter, e.g. @1 → @163.com). The first candidate is always your literal input, and Space commits it as typed — to take a completion, move with ←/→ or click, then press Space. Number keys inside this run are content, not candidate selectors.
When the local part is all digits (163@qq.com), @ still opens this half-width run as long as the character before the caret is a letter or digit; @someone, or @ at line start or after Chinese text, commits immediately as before.
Other symbols keep their Chinese meaning: /, #, and the backtick never trigger half-width mode (ta/ is still 「他/」).
4. Switching between Chinese and English, and mixing them
Section titled “4. Switching between Chinese and English, and mixing them”| Action | Keys |
|---|---|
| Chinese / English mode | Tap Shift |
| Full / half-width punctuation | Shift+Space by default (shape of punctuation in Chinese mode) |
| Simplified / Traditional | Ctrl+Shift+F by default |
English words in Chinese mode: Shift+letter keeps the capital in the composition and does not switch you to English mode. Decoding uses the lowercase form; Enter keeps the capitalization you typed.
| Input | Usual results |
|---|---|
A then gu | 「A股」 (A-shares), raw Agu… |
fenxiAI | 「分析AI」 (analyze plus AI), raw fenxiAI… |
macOS / CPU | Raw text. When the input cannot be read as pinyin, no characters are invented. |
niHao | 「你好」, raw niHao |
Space commits the current candidate; Enter commits the raw text. To type a whole run of English, tap Shift and go to English mode.
Caps Lock (while composing): characters you already confirmed commit, unconfirmed pinyin is dropped. If you have not picked a character yet, it acts like clearing. With the light on, the panel shows A and letters pass through as English.
5. When nothing comes out, check these three
Section titled “5. When nothing comes out, check these three”The candidate panel does not follow the caret
Log out and log back in. If it is still wrong, run: auri-doctor --repair-gnome-caret
Only pinyin, no characters
Check that the data pack (auritype-pinyin-data) is installed and that the runtime and the lexicon are the same generation. Run auri-doctor to see what loaded.
No output in Java / IntelliJ and similar apps
Run auri-doctor --repair-xim, then restart the app as it tells you.
Everything else — every auri-doctor flag, the logs, and the environment variables — is on Diagnostics and logs.
6. Version and license
Section titled “6. Version and license”Product name: AuriType (聆风). The runtime library (libauri) is BSD-3-Clause. The candidate panel and the IBus frontend and so on are GPL-3.0. The pinyin dictionary is derived from rime-wanxiang (CC BY 4.0). See the copyright file inside the package and the repository README; both repository URLs are on the Source page.