Overview

Installing the NPM module

Trying out Kipper

For simply trying out Kipper the following command can be used, which will globally install Kipper and the Kipper CLI, making Kipper available to the entire Node.js installation and your operating system (This also means you can call kipper from any terminal in any directory on your system):

npm install -g @kipper/cli
Bash

Add Kipper to your project

If you intend to use Kipper in a Node project, you can also install it locally in the project directory:

npm install @kipper/cli
Bash

This is preferred for projects, where version-specific features are used and the version is locked.

To add Kipper to your permanent project dependencies use --save or --save-dev to add it to the development dependencies:

npm install @kipper/cli --save/--save-dev
Bash

Replace @kipper/cli with @kipper/core if you want the core Kipper Compiler and API for Node.js.

Check Compiler installation

To check whether the Kipper compiler has been properly installed, run the following command in your project's working directory (where it has been set up) or if you have it installed globally, anywhere:

kipper --version
Bash

If the output shows something like the following output (version, operating system and nodejs version might be different), your kipper installation should be set up and ready to use!

kipper/0.8.1 win32-x64 node-v16.13.0
Bash

Important

On some systems the CLI identifier kipper may not work and as such as a replacement npx should be used. For example:

npx kipper
Bash

For yarn, you can also use:

yarn kipper
Bash

Including the Web Bundle

If you want to use Kipper inside your browser, then you can include the browser-standalone version of the compiler into your HTML file with the following script tag:

<script src="https://cdn.jsdelivr.net/npm/@kipper/web@latest/kipper-standalone.min.js"></script>
HTML

This will globally register the identifier Kipper, which can then be used to access the Kipper package.

For more info on how to get started with Kipper in the web go to the section [Running the Compiler in an HTML file](./docs/quickstart.html#running-the-compiler-in-an-html-file) in the Quickstart guide.

Important Version Info

Prior to v0.10.0 the web bundle was not available yet, so you will have to use an alternative method to include Kipper in your web project. For more info on how to do that, go to the versions-specific Quickstart Guide for v0.9.2.

Download Source Code

To download the latest stable source code of Kipper, download the compressed package as a zip or tar.gz with the links below: