Repository navigation
Getting Started
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:5000For a real deployment, see Deploying the Vertex server.
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 | bashPass options after
bash -s --, e.g.,| bash -s -- --version 0.1.0-alpha.2.--uninstallremoves it. -
Windows: download
vx-win-x64.zipfrom Releases and put it on yourPATH. -
From source: install the .NET 10 SDK, run
dotnet build Vertex.Cli -c Release, and addVertex.Cli/bin/Release/net10.0to yourPATH(or callvxby its full path).
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 areMost 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.
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.
On another machine, or for a teammate:
vx clone <project> # links a folder to the project and downloads the latest filesThen 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"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.
- Errors are one red line that names the command that fixes them, such as
vx loginorvx sync. -
vx infoshows which server you're talking to and why, and whether it's reachable. - Commands exit with
0on success and non-zero on failure so that scripts can check them.
- Concepts: projects, workspaces, branches, revisions and locks.
- Command reference: every command and option.
- Best practices: how to set up a project and a team.