Install tools

Plis is similar to npm and you can install tools globally or locally(project based), the tools are stored in 2 locations:

  • Global tools : are stored in $HOME/.plis/tools
  • Project tools: are stored in plis/tools folder in the working directory.

Generators are usually stored as a git repository and you can install project tools by running:

plis get https://github.com/kujtimiihoxha/plis-tool

or global tools :

plis get -g https://github.com/kujtimiihoxha/plis-tool

where https://github.com/kujtimiihoxha/plis-tool is the repository url.

🚧

GIT

Plis uses git so git is a requirement of plis

One other way to install tools is by providing a plis.json file where all the plis dependencies are listed.

{
    "dependencies": [
        {
            "rep": "[email protected]:kujtimiihoxha/plis-tool",
            "branch": "master"
        }
    ]
}

This file must be present in the working directory and then you can run the install command.

plis install

Plis also supports a way of "versioning" by using branches so for e.x if you would like to get a specific version of the tool you would specify the branch you want to install (assuming that the creator of the tool follows this system of versioning), this can be done by using the branch property as shown in the json above or by using the --branch flag e.x:

plis get https://github.com/kujtimiihoxha/plis-tool --branch v1

When using plis get command for installing project tools plis automatically creates a plis.json file in the working directory and stores the dependencies of your project there.