Files
nyaterm/docs-site/i18n/en/docusaurus-plugin-content-docs/current/faq.md
T
KangandClaude Opus 5 e18cb3902e docs: cut the template phrasing and the authoring notes
The migrated prose leaned on a small set of constructions and repeated them
until they stopped carrying information. Across ~3.7k lines the source had 78
uses of "适合", 63 of "如果你", and 34 contrastive "而不是" clauses, most of
them attached to bullet lists that restated the feature name.

What changed:
- Replaced the "适合场景 / 适合:" tail hanging off nearly every section with
  either a plain sentence or nothing. "适合" is now 0, "如果你" is 0, and the
  18 remaining "而不是" clauses each rule out an assumption a reader would
  actually make (a rejected password is not truncated; a font name is not a
  bundled file; a decoder panic must not exit silently).
- Removed the closing editorial lines that asserted significance without adding
  information ("这也是 NyaTerm 和普通多标签终端差异较大的地方"), and the
  meta-commentary where the docs explained their own conventions.
- Dropped the relative time anchors that were already going stale: "新的 SFTP
  后端", "较新的工作区", "现在可以", "Newer Agent workflows".
- Deleted the "如果你准备录制文档素材" passage, which told the reader how to
  stage screenshots for the docs rather than how to use the recorder.
- Removed seven `:::tip Screenshot suggestion` blocks that shipped only in the
  English pages. They were internal authoring notes and pointed at a
  /img/docs/ tree and scripts/demo-*.sh files that do not exist in this repo.
- Dropped "推荐的工作流组合", four permutations of features documented
  elsewhere, and gave the synchronized input group one home instead of the
  three partial copies it had across two pages.
- Rewrote the cloud-sync conflict choices to lead with what is lost, since
  "适合:你确认云端版本才是应该保留的版本" buried the fact that local
  unsynced changes are discarded.

Also closes the remaining English gaps found while doing this: selection and
bulk operations, content-fingerprint upload, two FAQ entries, and two
quick-start steps existed only in Chinese. Chinese and English now carry the
same heading count on every page.

Verified with `pnpm --dir docs-site build` (both locales) and by re-resolving
all 22 cross-page anchors against the generated heading ids.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-22 11:27:47 +08:00

5.9 KiB
Raw Blame History

FAQ

Sessions and connections

SSH works, so why do Local Terminal, Telnet, Serial, RDP, and VNC behave differently?

Because NyaTerm supports multiple session types, and their capabilities are not identical:

  • SSH — the most complete workflow, including SFTP, OTP, resource monitoring, proxy, jump host, and tunnels
  • Local Terminal — local shell workflow only
  • Telnet — lightweight remote terminal without SSH-specific features
  • Serial — serial debugging, not an SSH network path
  • RDP — graphical remote desktop without text-terminal behavior
  • VNC — traditional RFB graphical desktop; some real-server combinations are still being validated

If you need the file explorer, remote resource monitoring, or OTP, make sure the current tab is an SSH session.

Why is the file explorer missing for some sessions?

The file explorer depends on SFTP, so it is only available for SSH sessions.

These session types do not provide the remote file explorer:

  • Local Terminal
  • Telnet
  • Serial
  • RDP
  • VNC

Why can’t I see remote resource monitoring?

Check both of these:

  1. The current tab is an SSH session
  2. Show Remote Resource Stats is enabled in Settings → Terminal

Resource monitoring is on by default; turning this setting off also hides the Resource Monitor icon in the right activity bar.

What should I do if the serial port list is empty?

Check that:

  • The device is physically connected
  • The operating system recognizes the serial port
  • Another tool is not already holding the port open

When you reopen the port dropdown on the Serial tab, NyaTerm reloads the available ports.

Terminal experience

Usually one of these is true:

  1. Action Links is not enabled in Settings → Terminal
  2. You are not using Ctrl / Cmd + click

Action links are disabled by default, and opening them requires a modifier key to avoid accidental activation.

Why can’t I see keyword highlighting?

Keyword highlighting is disabled by default. Enable it first in Settings → Terminal, then confirm the current output actually matches one of the configured rules.

Why are line numbers and timestamps not visible?

These are also optional enhancements. Enable them separately in Settings → Terminal.

Why are there no models available in the AI Assistant?

Check, in order:

  1. Whether AI is enabled in Settings → AI
  2. Whether at least one provider is configured and enabled
  3. Whether at least one model is enabled for that provider

When using a custom provider, confirm it is OpenAI-compatible and that the base URL, API key, and model discovery results are all correct.

Why doesn't the app quit when I close the window?

Check Minimize to tray when closing in Settings → General.

When it is on, closing the main window moves the app to the tray instead of quitting, and active sessions and sync jobs keep running.

File transfer

Why didn’t the auto-upload prompt appear after I opened a remote file?

The auto-upload prompt only appears in this workflow:

  1. You choose Open on a remote file from the SSH file explorer
  2. NyaTerm downloads it into a local temporary directory and starts watching it
  3. You save that watched file in your local editor

If you copied the file elsewhere and edited that copy manually, NyaTerm no longer knows it maps back to the remote file.

Why didn’t the file explorer follow my cd command automatically?

Auto-follow depends on terminal path tracking support for the session. If the current session does not support it, automatic sync is disabled and you need to trigger sync manually.

Where do uploads and downloads go?

That depends on your transfer settings:

  • If ask every time is enabled, NyaTerm prompts for a destination on each download
  • Otherwise it uses the default download directory

You can also change the default download path and the default editor in settings.

Security and authentication

Why can I unlock the screen without entering a password?

Because screen lock is enabled, but no master password is set yet.

In the current behavior:

  • With a master password: unlocking requires the master password
  • Without a master password: unlocking can be done directly

What if I forget the master password?

There is currently no built-in recovery flow for the master password. If your local data is protected by it and you can no longer provide the correct password, those protected sensitive settings cannot continue to be used in the original way.

Before making manual changes, back up the data directory for the current mode: usually ~/.nyaterm/ for an installed build, or the adjacent data/ directory for portable mode.

Where should OTP entries be managed?

Manage them centrally in the OTP tab of the Security/Auth panel, then bind them to individual SSH connections in the connection form.

Import and migration

Which clients can NyaTerm import sessions from?

Xshell, MobaXterm, WindTerm, SecureCRT, FinalShell, Termius, and NyaTerm / Electerm JSON. Each format and its caveats are documented in Importing sessions from other clients.

After import, review the username, port, authentication method, and whether proxy / jump host / OTP binding still needs to be configured.

Where are NyaTerm’s config files stored?

In installed mode, the main data file is normally ~/.nyaterm/nyaterm.redb; portable mode uses configuration data under the adjacent data/config/ directory. This data includes settings, connections, keys, OTP data, tunnels, proxies, history, and other local state.

Legacy Dragonfly data is handled through compatibility fallbacks for old encryption prefixes and storage documents. NyaTerm does not promise to copy the entire ~/.dragonfly/ directory or create a rollback copy on first launch.