Get Started
To start using Matter with your project, you need to:
Log in to your Matter organization.
Connect your GitHub project to Matter.
Help Matter set up its preview environment.
Connect your project to Matter
Log in to your Matter organization as an Administrator.
Click Add project. Matter will guide you through the following steps.
Enter your GitHub repository URL, for example: https://github.com/org-name/repo-name.git
If in doubt, click Where to find link for help.
Make sure the URL is correct.
Give your project a name, or use the one Matter suggests, which reflects your repository name.
Next, Matter will ask you for your credentials to access the repository on your behalf.
The required credentials depend on your repository access rules and where it's hosted:
For most GitHub repositories, you need to provide a personal token. Matter will help you generate one.
Click Get personal token — you will be redirected to the GitHub token page with all the necessary permissions pre-selected.
Give the token a name, hit Create, then copy your token and paste it into the Matter prompt.
If connecting via SSH, you will be asked for your SSH private key and the passphrase if your key is protected with one. Your SSH key is usually stored on your local machine in the .ssh\ subdirectory.
Some repositories may require your username/password.
Once you've entered the correct URL and credentials, Matter will respond with: Project successfully created!. That means that your repository is connected and mirrored, and you are ready to proceed to the next step.
Set up preview environment
To process tasks and expose changes for preview, Matter explores your repository and sets up a runtime environment.
It does it in three steps:
Services. It looks for and identifies services that are necessary to run your project application in development mode.
Secrets. It checks if there are any environment variables, keys, or other secrets required for your application to run.
Preview. It examines configuration files, checks for dependencies and creates scripts to activate the runtime environment and enable preview.
At each step Matter might ask you for more information or lets you change its settings manually.
Services
Matter tries to identify the services and describes them. If several services are found, it displays them all and lets you manually choose only the essential ones that should be enabled to run your project frontend.
Secrets
If your project application has a backend or makes external API calls, it may contain secrets such as environment variables, keys, URLs.
Matter tries to detect the required secrets. If any are found, they will be listed, and you’ll be asked to provide their values. If you believe a particular secret is not necessary for running the application, you can deselect it using the toggle.
Preview
Matter prepares your project for live preview by analyzing the codebase and setting up the required environment. It inspects the repository structure, reads configuration files, and determines what dependencies or services are needed. Based on this analysis, Matter automatically generates two types of scripts to ensure the application runs smoothly:
Warmup script — handles environment preparation tasks, such as checking configurations, verifying runtime settings, and installing dependencies if needed. This ensures the project is in a ready-to-run state.
Run service script — starts the application in a way that matches the project’s configuration (for example, launching a development server). This makes the application accessible for preview.
After creating and verifying these scripts, Matter activates the runtime environment, executes the warmup steps, and runs the application. The result is a fully functional live preview of your project.
You are all set to use Matter!
Add and manage teammates
You can invite your teammates to your Matter organization to collaborate on projects.
On your Matter home page, click your user icon in the lower left corner
Choose
All current users are listed here.
Click Invite teammates, enter their email and role (Admin or Member) and send the invite.
Member - can collaborate on a project, send prompts and interact with other users.
Admin - can add and manage projects and users.
Once a teammate is registered with the organization, you can mention them in a project chat to invite and work together.
Add and manage projects
You can have multiple projects in your Matter organization. Each can be linked to the same or different Git repository.
All existing projects are displayed on the home page.
To return to the home page from anywhere, click the blue icon in the upper left corner.
To set up a new project, click the Add project card and complete the setup.
To quickly find your project, click the triple dot menu on its card and add it to Favorites.
To delete a project, click the triple dot menu on its card, then choose Delete project.