Getting started with Veyra

Install

Get the installer for your system from the download page. Veyra is free, and installs in under a minute.

Windows 10 and 11

Run the .exe installer (or the .msi for managed installs). Preview builds aren't signed by Microsoft yet, so SmartScreen may say "Windows protected your PC": choose More info → Run anyway.

macOS 11 or newer

Choose the .dmg for Apple silicon (M1 and later) or Intel, then drag Veyra Studio into Applications. The first time, right-click → Open, or allow it in System Settings → Privacy & Security → Open Anyway.

Linux

Use the .AppImage on any 64-bit distribution (chmod +x it, then run it), or install the .deb (Debian, Ubuntu) or .rpm (Fedora, openSUSE) package. Veyra needs WebKitGTK 4.1 and glibc 2.35 or newer.

Your first project

1. Start Veyra and choose Open a project, or press Ctrl+O (⌘O on macOS).
2. Pick any folder. The explorer shows its files, with Git status badges if it's a repository.
3. Click a file to open it in a tab. Press Ctrl+P to jump to any file by typing part of its name.
4. Edits are kept safely until you save with Ctrl+S. Turn on Auto save or Format on save in Settings.

Keyboard shortcuts

The shortcuts most people use every day. Every command, with its shortcut, is in the command palette and in Settings → Keyboard shortcuts.

Language tools (TypeScript, ESLint, Prettier…)

Every language gets syntax highlighting, snippets and completions. For full IntelliSense in web projects, install language tools from Extensions → Discover → Web development:

• TypeScript & JavaScript (Node.js): real errors, auto-imports, hover docs, go to definition, rename across files and quick fixes, using your tsconfig.json and node_modules types.
• ESLint: your project's lint rules as you type, with quick fixes.
• Prettier: Format Document (Shift+Alt+F) or format on save, with your project's Prettier version and config.
• Tailwind CSS, Emmet, Svelte and Vue.
• Python (Pyright): errors, completions, hover and go to definition, using your project's virtual environment.

Debugging (Python)

Open Run and Debug (the bug icon) and click Install once. Then:

• Click beside a line number, or press F9, to set a breakpoint.
• Press F5 to debug the open Python file. Veyra stops at your breakpoints and highlights the line.
• Step over with F10, into with F11, out with Shift+F11; continue with F5 and stop with Shift+F5.
• Inspect Variables, add Watch expressions, walk the Call stack, and evaluate code in the Debug Console.

Live Server

Click Go Live in the status bar to serve the open folder and open it in your browser. To open a specific page, right-click an HTML file and choose Open with Live Server, or press Alt+L Alt+O.

• Saving HTML or JavaScript reloads the page. Saving CSS applies the new styles without a reload.
• The status bar shows the port while Live Server runs. Click it, or press Alt+L Alt+C, to stop.
• Folders without an index.html show a list of their files.

Set up Veyra AI

AI is optional. Veyra's assistant uses Veyra AI, and all you need is a free Veyra account. There's no API key to paste.

1. Create a free Veyra account (or use the one you have).
2. In Veyra, open the AI panel with Ctrl+L (⌘L on macOS) and sign in with your email and password.
3. Start asking. Every account gets 10 free Veyra AI requests in total, and the panel shows how many you have left. A request that fails isn't counted.

What you can do

• Ask about your code. Attach the current file, a selection or smart workspace context, and Veyra shows exactly which files are included.
• Edit with AI (Ctrl+K): describe a change and review it as a diff before it's applied. Applied edits can be undone.
• Explain the selected code in plain language.

Git

Open Source control (Ctrl+Shift+G) to stage files, write a message and commit with Ctrl+Enter. You can amend, switch and create branches, stash, pull and push, and view history. Changed lines are marked in the editor gutter, and files show status badges in the explorer.

Extensions & themes

In Extensions, search the Open VSX marketplace. Themes and snippets install directly. Popular VS Code extensions such as ESLint, Prettier, Tailwind CSS, Volar, Svelte, Python Debugger and Claude Code are marked Built into Veyra and install Veyra's equivalent. Claude Code installs with Anthropic's official installer in the terminal and opens in your project with one click. You can also Install from VSIX.

Extensions that run their own code need a VS Code extension host, which is on the roadmap.

Updates

Veyra checks for new versions automatically. When one is ready, the Sign in button in the top-right corner turns into a glowing Update button; click it and Veyra installs the update and restarts. Updates are signed and verified before they install, and never interrupt unsaved work. You can also run Check for updates from the command palette. See what changed in the changelog.

Troubleshooting

A language tool says "Failed to start"

Check that node --version prints 18 or newer in a terminal, then click Restart on the tool in Extensions. The card shows the server's last error message.

No IntelliSense in a TypeScript project

Make sure the TypeScript & JavaScript tool is installed and enabled, and run npm install in your project so type definitions exist in node_modules.

Something feels slow or broken

Open the Health monitor from the command palette. It checks responsiveness, memory, errors, Git and your toolchain, and suggests a fix for each warning.

Still stuck?

Open an issue on GitHub with your operating system, Veyra version (from the release you downloaded, or the changelog entry of your last update) and what you expected to happen.

Build from source

Veyra is open source under the MIT license. To build it you need Node.js 22 or newer, Rust (stable) and your platform's Tauri prerequisites. (Running Veyra's optional language tools only needs Node.js 18+.)

git clone https://github.com/fcopensource/veyraeditor.git
cd veyraeditor
npm install
npm run tauri dev

Pull requests are welcome. See the repository's README for the project layout and tests.