Installation

There are currently a few different ways you can install Capti.

• Globally with NPM
• Locally with NPM for NodeJS Projects
• Anywhere else by downloading the binary executable

Global NPM Install

Installing globally is the easiest way to get started with Capti if you already have Node/NPM installed.

$ npm install -g capti

This will make Capti available for you to use in any project at the command line. To verify that your installation succeeded, you can run:

$ capti --version

Note: If your installation did not succeed, please report the issue so that any necessary fixes can be made.

Local NPM Install

Installing Capti locally in an NPM project is useful when you share your project with other developers and don't want them to have to globally install anything. It's also useful if you plan to use Capti for continuous integration in your project.

To install locally in an NPM project, cd into your project directory and run:

$ npm install --save-dev capti

Note: If your installation did not succeed, please report the issue so that any necessary fixes can be made.

This will save Capti as a development dependency (meaning that it won't bundle into your final build). To use Capti in your project, first create a new folder in your project directory tests/ (you can name it whatever you want). Then open your package.json and add the following script:

{
    "scripts": {
        "test:capti": "capti --path ./tests"
    }
}

The to run the tests your project, all you need to do is run:

$ npm run test:capti

Binary Executable

If you want to install Capti on the command line but you do not want to use NPM or don't have Node installed, you can download the binary executable for your platform/architecture and manually add it to your PATH.

To access the binary executable downloads, head over to the project's GitHub Releases and download the latest version.

Note: If you don't see your platform/architecture as a download option, and you think it should be available, feel free to put in an enhancement issue and we can look at possibly adding support for your architecture.

Instructions for adding the binary to your PATH environment variable varies system-to-system. Please expand the section below for your platform.

$ mv capti /usr/local/bin/capti

export PATH="/usr/local/bin/capti:$PATH"

$ capti --version