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 base branch.
Run on Base Branch First
Since Emtrey compares changes across branches, you must run Emtrey on your base branch before running it on any other branches (eg.
main, etc). This gives Emtrey a concept of what is likely deployed to production and a baseline for comparing other future changes/branches.
- Navigate to the root directory of your project.
- Switch to your base branch (eg.
git checkout master).
- Start your application locally.
- Run the following Emtrey CLI command from the project root:
npx emtrey --port=<PORT>
All projects must have a run-through on the base branch (eg.
Once Emtrey has completed running, a baseline for your project has been established and can be viewed in your Emtrey Dashboard. If you review the base branch run-through, you will see the following instruction on how to run Emtrey again on other branches and the initial screen captures that were recorded:
Tips and Tricks
Ready to take the next step and run Emtrey on a new branch? See how at Using the Emtrey CLI.