Getting Started with Version Matrix

Step 1: Create an Account and Log In

First, visit Version Matrix (opens in a new tab) and sign up for a new account. Once you've created your account, log in to access the Version Matrix dashboard.

Step 2: Create a Project

• Navigate to the Dashboard: Once logged in, you'll find the option to create a new project.
• Project Setup: Enter a name for your project and any other required details. This project will serve as a container for all your environments and services.

Step 3: Set Up Environments

• Default Environment: By default, a 'Production' environment is created. You can use this or modify it as needed.
• Additional Environments: To add more environments (like Staging, Testing, etc.), go to the environment settings and click on "Add Environment." Customize each environment's settings according to your deployment stages.

Step 4: Set Up Services (Optional)

If your project consists of multiple services, you can define each one within the project dashboard:

• Add Services: Go to the Project settings page, click on Add service button and provide the necessary details such as the service name.

Step 5: Prepare Project Key

• Access Token: Navigate to Project Settings within your project's dashboard. Here, you can generate a new Access Token under the "Access tokens" section.
• Keep It Secure: Remember, your access token is crucial for your project's security when using the CLI. Keep it confidential.

Step 6: Install the CLI Tool

To install the Version Matrix CLI tool on your machine, open your terminal and run:

npm install -g vmtrx

This command installs the tool globally, making it accessible from anywhere in your terminal.

Step 7: Export the Project Token

Set your project token as an environment variable to authenticate the CLI requests:

export VERSION_MATRIX_PROJECT_KEY=your-project-key

Replace your-project-key with the actual access token you created earlier.

Step 8: Update Your Project Version

To update the version of your project, use the following command:

vmtrx update-version your-environment-name your-version

Replace your-environment-name with the name of your environment (e.g., Production, Staging) and your-version with the new version number you wish to set.