usage-guide.mdx

usage-guide.mdx (2547B)

1 ---
2 title: "Comprehensive Usage Guide"
3 sidebarTitle: "Usage Guide"
4 ---
5
6 import Copyright from "/snippets/copyright.mdx";
7
8 How to operate Veyrix IDE effectively — file management, keyboard shortcuts, versioning, and sharing.
9
10 ## 1. Managing files
11
12 **Creating a new file** — click the `+` icon in the sidebar (or the floating button on mobile). Type your desired filename including the extension (e.g. `script.js`, `index.html`, `Dockerfile`). Veyrix auto-detects the language from the extension for syntax highlighting. Files without an extension are allowed.
13
14 **Importing an existing file** — click the Open File icon (folder with up arrow) in the top navigation bar, or press `Ctrl+O`. Select any valid text, configuration, or code file. Binary files (images, compiled `.exe` files) are rejected.
15
16 **Renaming or deleting** — hover over any file in the left sidebar and click the three-dots (`...`) icon. From the dropdown: Rename, Delete, or Download that specific file.
17
18 ## 2. Editing & formatting
19
20 **Autosave & manual save** — Veyrix caches your typing to the local database 500ms after you stop typing. A blue dot next to the filename in the top bar indicates unsaved changes. Force a save any time with `Ctrl+S` or the floppy disk icon.
21
22 **Code formatting (Prettier)** — press `Alt+Shift+F` to beautify code (fix indentation and spacing). Only supported for recognized web languages: HTML, CSS, JS/JSX, JSON, Markdown.
23
24 ## 3. Snapshots (local version history)
25
26 Veyrix has a built-in "Time Machine" for your files.
27
28 - **Save a snapshot** — click the bookmark icon top right; saves a frozen copy of your code at that moment
29 - **Limits** — max 5 snapshots per file; saving a 6th prompts you to permanently delete the oldest one
30 - **Restore** — click the clock icon to view history; clicking "Restore" on an older version immediately replaces your current editor content with the historical code
31
32 ## 4. Sharing code
33
34 Click the Share icon to open the sharing modal. Three options:
35
36 **Fast local share** — compresses your entire file into the URL; no data leaves your browser. Best for small snippets, since large files produce very long URLs.
37
38 **Cloud share** — uploads your code to an anonymous, secure Firebase database and generates a short link. Can optionally be protected with a password (hashed client-side — see [Security & Threat Model](/veyrix/security)).
39
40 **Share via device** — uses your phone or computer's native share menu (AirDrop, WhatsApp, Email, etc.) to send the raw text of your code.
41
42 <Copyright />