Skip to content

FAQ.md

Latest commit

 

History

History
69 lines (51 loc) · 2.78 KB

FAQ.md

File metadata and controls

69 lines (51 loc) · 2.78 KB
Raw

FAQ

How do I run the app?

pnpm install
pnpm --filter desktop exec tauri dev

How do I run the tests?

pnpm test (frontend) and cargo test in apps/desktop/src-tauri (backend), or ./scripts/test.sh for both.

Where are settings stored?

In Tauri builds, the Rust backend stores settings.json in the platform app-config directory. In browser dev mode, the validated localStorage fallback is used so pnpm dev works without the backend.

Why does the frontend not call filesystem APIs?

All filesystem, drive, and dialog work happens in the Rust backend by design. The webview is granted only core:default and CrossPort's own commands, so the attack surface stays minimal.

What error format does the backend use?

{ "code", "message" } objects with stable codes, one per backend failure category: invalid_input, path_not_found, path_not_directory, permission_denied, io, unsafe_relationship, not_enough_space, disk_full, too_many_items, transfer_not_found, transfer_failed, verification_failed, state_unavailable, recovery_unavailable, and internal. The frontend normalizes them to IpcError and switches on code, never on the message. apps/desktop/src/services/ipc.ts and apps/desktop/src-tauri/src/errors/mod.rs are the two lists that must stay in step; docs/architecture/ERROR_HANDLING.md is the reference.

Where are the backend logs?

stdout and a rotating crossport-named file (5 MiB × 3) in the platform app-log directory. Startup logs print the resolved config and log directories, and the user-facing path is listed in docs/development/SETUP.md.

Why does a volume show no capacity?

Because the platform did not report any. An empty optical drive, a disconnected network share, and a mount point CrossPort cannot classify all answer with "unknown" instead of a guessed number, and a volume whose media is not ready is listed as Not available. Facts the OS cannot provide are never invented.

Which commands does the backend expose today?

The command surface is grouped by domain in apps/desktop/src-tauri/src/commands/:

  • App and platform: get_system_info, list_drives, pick_directory, exit_app
  • Filesystem browsing: inspect_path, list_directory, list_ancestors
  • Settings: get_settings, update_settings
  • Transfers: plan_transfer, start_transfer, list_transfers, get_transfer, pause_transfer, resume_transfer, cancel_transfer, remove_transfer, clear_finished_transfers
  • History: list_history, get_history_record, delete_history_record, clear_history, get_archive_status
  • Recovery: list_recovery_candidates, get_recovery_candidate, recover_transfer

lib.rs (invoke_handler) is the authoritative list; a command that is not there is not reachable from the frontend.