menuKatnip CLI
Tutorialkeyboard_arrow_right
Concepts and Featureskeyboard_arrow_right
How Tokeyboard_arrow_right

The katnip command line tool is used to run project related tasks, such as creating a project, starting a development server or deploying your project.

Installing

Install the katnip command line tool as you would install any package from NPM, i.e. with:

npm install -g katnip

or

yarn global install katnip

Then to make sure it worked, just type katnip at the command line prompt.

The command line tool will behave slightly different if your current shell working directory is inside a project or outside.

Running the katnip CLI outside a project

Outside a project it is being used mainly to create a new project. To create a project type, for example:

katnip create myproject

Then do cd myproject and run katnip again and you will now be running the tool inside the project.

Running the katnip CLI inside a project

Inside a project there will be various sub-commands available. These are all added by plugins. Plugins can add commands, as well as modify and add parameters for existing commands. At first, the command you will probably want to run is katnip dev to start a development server.