Skip to content

Getting Started

Kyle Ebbinga edited this page Nov 19, 2026 · 2 revisions

1. Run a server

You need Docker. The repository's compose file starts the server with PostgreSQL, Redis, and an S3-compatible storage, we recommend either SeaweedFS or Wasabi!

Using throwaway development credentials:

git clone https://github.com/EntexInteractive/Vertex.git
cd Vertex
docker compose up -d --build          # server + PostgreSQL + Redis + SeaweedFS on http://127.0.0.1:5000

For a real deployment, see Deploying the Vertex server.

2. Install vx (the Vertex command-line)

Pick one:

  • Linux and macOS: install the latest release. Run the same command again to update.

    curl -fsSL https://raw.githubusercontent.com/EntexInteractive/Vertex/main/install.sh | bash

    Pass options after bash -s --, e.g., | bash -s -- --version 0.1.0-alpha.2. --uninstall removes it.

  • Windows: download vx-win-x64.zip from Releases and put it on your PATH.

  • From source: install the .NET 10 SDK, run dotnet build Vertex.Cli -c Release, and add Vertex.Cli/bin/Release/net10.0 to your PATH (or call vx by its full path).

3. Point vx at the server and log in

vx config server http://127.0.0.1:5000   # the default server for every command on this machine
vx login -u admin                        # the compose stack's first admin; the password is VX_ADMIN_PASSWORD (default: vertexadmin)
vx info                                  # shows the server version, latency and who you are

Most commands also take --server <url> for a one-off server. vx picks the server in this order: --server, the workspace's server, vx config server, then defaults to http://127.0.0.1:5000.

4. Make a project and submit

cd path/to/your/project
vx init                # creates a project named after the folder and makes this folder its workspace
vx status              # lists files changed since the last submit or sync
vx submit -m "Initial" # submits every change as one revision (#1)

NOTE: It is recommended to use a .vxignore for large projects.

5. Work with others

On another machine, or for a teammate:

vx clone <project>   # links a folder to the project and downloads the latest files

Then the daily loop is:

vx sync              # get what others submitted
vx                   # optional: keep a session open, so files lock as you save them (useful with large teams!)
vx status
vx submit -m "Fix jump"

The interactive session

Running vx with no command opens a prompt (Vertex >) that stays open until you type exit. Inside it, type commands without the vx prefix. While the session is open in a workspace, it watches that workspace, locks files after you save them, and prints what others lock and submit as they happen. See File locking.

When something goes wrong

  • Errors are one red line that names the command that fixes them, such as vx login or vx sync.
  • vx info shows which server you're talking to and why, and whether it's reachable.
  • Commands exit with 0 on success and non-zero on failure so that scripts can check them.

Next

Clone this wiki locally