Skip to main content
Get started with Playmatic in just a few minutes. This guide will walk you through creating your first test and running it locally.

​
Before you begin

Make sure you have:

​
Step 1: Navigate to your application directory

To get started, we’ll navigate to your application directory. 
cd your-directory

​
Step 2: Install Playmatic in your directory

Install the Playmatic SDK and the CLI tool. 
npm i -D @playmatic/sdk
npm install -g playmatic

​
Step 3: Provide your API key

The Playmatic CLI requires a Playmatic account to use. When you start a session with playmatic, you will be asked to provide your account’s API key. 
playmatic setup
# You'll be prompted to provide your API key.
Follow the prompt to get the API key from your Playmatic account, and paste it into the terminal. Your credentials will be stored so you won’t need to do this again in the future.

​
Step 4: Run your first test

Let’s execute the sample.test.ts that was created in your playmatic-tests directory. 
# Run your first test
playmatic run
Congratulations! You’ve successfully run your first Playmatic test.

​
Next Steps

Creating tests

Learn more about creating robust tests using natural language + code.

Running tests

Learn more about automated test maintenance and self-healing at runtime.