How does Emtrey use your source code? We understand you may have some security concerns about a third party reading privileged information regarding your source code and data. Emtrey will never transmit or store any of your source code or data. Emtrey will transmit...
Help Center
Getting Started
Supported Frameworks
Overview Below is a list of supported web application frameworks that Emtrey officially supports and is regularly tested on. We continually add new supported frameworks and this list is kept up to date.Web Application Frameworks React Angular Gatsby Vue.js Phoenix...
Establish a Baseline for a Project
Overview Emtrey requires all projects to be managed by version control, git. No matter which branching strategy your team follows (eg. gitflow), utilizing different branches and commits is key to Emtrey tracking changes. By default, Emtrey compares all branches to the...
Installing Emtrey
Prerequisites Before you can use Emtrey, you will need to make sure that you have Node (and it's accompanying package manager, npm) installed on your machine. Running Emtrey For Emtrey to inspect an application for changes, run these steps: Navigate to the root of...
Emtrey CLI Tool
Using the Emtrey CLI
Overview The Emtrey CLI is a command-line tool that allows developers to connect their web application to the Emtrey service. The main purpose of the Emtrey CLI is to scan your web application for the latest changes, capture renders of these changes and send them to...
Using Emtrey
Setting User Permissions
Overview Emtrey allows you to configure a user's permissions to match your team's needs and workflow. When you invite a user, you can choose from one of four permission levels (see Available Permissions section). Owners and Admins can also change a user's permission...
Adding Team Members
Overview Adding team members to Emtrey projects allows you to collaborate on reviewing page run throughs. When you invite a user, you can choose from one of four permission levels (see Available Permissions section). Owners and Admins can also change a user's...
Reviewing Changes
Overview At its core, Emtrey is a collaboration tool. After using the Emtrey CLI, a run-through for a project is created and made ready for review. In this doc, you will learn how to review and comment on changes and mark changes as approved and unapproved.Review...
Integrations
Using CI/CD with Emtrey
Overview Emtrey gets even better when you connect it to your CI/CD pipeline, such as CircleCI and Jenkins. After adding your Emtrey API token to your CI/CD tool, Emtrey runs automatically with each commit you make.Configure Your Project for CI/CD To connect an Emtrey...
How to Review Changes via GitHub
Prerequisites Github is connected to the Emtrey project. Learn how to connect Emtrey projects to Github. Overview As the reviewer of a Pull Request (PR) you have the ability to navigate from GitHub to an Emtrey project. There you can approve, reject and leave comments...
Connecting to GitHub
Overview Emtrey gets even better when you connect it to a GitHub repository. After connecting your GitHub account, Emtrey reports the state of a run-through to a GitHub pull request via GitHub Checks. GitHub Checks provides you with workflow status messages right on a...
Configure Emtrey
Manually Adding Application Routes
Overview Emtrey can automatically detect all of your application's routes by parsing router files, but in case you want granular control over the URLs Emtrey analyzes, you can customize the URLs by using a configuration file. If you don't already have an...
Ignoring Certain Routes
Overview Emtrey will automatically discover what routes to visit when not using a custom route config. In the case you have some routes you don't want included in the process, you can specify them in the Emtrey config. If you don't already have an emtrey.config.js...
Providing Credentials For Protected Routes
Overview If your application requires a user to be logged in to access a route, you may define login credentials in your emtrey.config.js file. These credentials will be used in conjunction with the provided login URL, and automatically entered before visiting each...
Setting Up An Emtrey Configuration File
Overview Emtrey offers finer control over certain functionality such as: logging in, delaying screenshots, skipping routes, and more. In order to access this, Emtrey must read a configuration file in the root of your project's directory. To configure Emtrey, follow...
Troubleshooting
How to fix “Could not compare ….. to master branch” error
Overview If you have ever seen this error when first initializing a project in Emtrey, it is likely that you have not run it on your base branch first. Emtrey requires all projects to be managed by version control, git. No matter which branching strategy your team...
Release Notes
We are always working to make Emtrey smarter and faster. To learn about the latest improvements, check out our release notes.