Skip to content

Getting Started

FlexVault is used through the fxv command line. Install the CLI for your platform below, then follow Getting Started with the CLI to set up your first workspace and repository.

FlexVault is CLI-only today

FlexVault Desktop, a graphical application, is still in development. The installer below sets up the fxv command-line tool only.

Install FlexVault

Most Windows users should use this option.

Download FlexVault for Windows

The setup wizard (FlexVaultSetup.exe) installs FlexVault for your Windows user account without requiring administrator permissions. It installs the fxv CLI (core command-line engine, added to your PATH for terminal use).

After installation, see Getting Started with the CLI to create your first repository and workspace.

Use this option if you prefer a scripted install, such as on a machine you are setting up remotely. For headless or terminal-only setups, run the install script:

irm https://fxv.dev/install.ps1 | iex

The script installs fxv into %LOCALAPPDATA%\fxv\bin and adds it to your user PATH. Open a new terminal window for the updated PATH to take effect.

Then see Getting Started with the CLI to create your first repository and workspace.

Run the install script in your terminal:

curl -fsSL https://fxv.dev/install.sh | bash

The script installs fxv into ~/.local/bin and adds that directory to your shell configuration if needed.

Then see Getting Started with the CLI for the command-line tutorial.

macOS builds are planned but not published yet. Check fxv.dev/download for updates.

Windows Defender and SmartScreen warnings

Because release binaries and installers are newly published, Windows Defender or SmartScreen may display a warning ("Windows protected your PC") when running FlexVaultSetup.exe or install.ps1. This is expected for a newly released tool and is safe to proceed past: click More info and then Run anyway.

Next steps

Continue to Getting Started with the CLI to create a repository, initialize a workspace, and run your first snapshots and syncs. If you are trying FlexVault out on your own, you can create a repository on your local filesystem with no cloud account needed; cloud storage is there when you are ready to share a repository with a team.

Editor and engine plugins

Once you have a workspace, editor and engine plugins integrate FlexVault directly into your workflow: