Skip to content
Spartify

Getting Started

Spartify.io is a end-to-end, enterprise-level test automation framework built on top of Spatify Cloud. This guide will help you to get started with a new project. For more detailed instructions, refer to the manual setup guide for creating a brand-new project.

Quick Start

Create a new project:

Create a new Spartify.io test project by running the following command in your terminal

npm i -g @spartify/cli

This will install spartify/cli on your local machine as a global package, allowing you to access it from anywhere on your system.

You will then be able to build and create a new test automation framework with a single CLI command directly from your terminal.

spartify init

This will create a new project directory with all the necessary files and configurations for your project.

When working CLI, the terminal allows you to preview your build archetypes, run sample tests, and execute them in headless mode.

To initialize the framework and start scripting with latest framework updates, navigate to your project directory and run the following command:

npm spartify-update
  • Directoryspartify
    • Directorye2e/
      • …
    • Directorypages/
      • …
    • Directorysupport/
      • …
  • .env
  • .gitignore
  • package.json
  • spartify.config.ts
  • spartify.initialize.js
  • ts.config.json

You can make adjustments or changes to the existing project and perform a dry run using the following command:

npm spartify-run

If required, the same can be done in GUI mode.

npm spartify-open