Website and Docs were moved to https://luna-klatzer.github.io/Kipper. Please refrain from using the old website, as it displays information prior to v0.9.1.

Include Kipper in an HTML file

If you want to use Kipper inside your browser, then you can include the browser-standalone version of Kipper:

<!-- Babel dependency -->
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>

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

For more info go to the quickstart guide here.

Install 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

Important

If possible avoid installing Kipper globally if you intend to use it inside your own projects, as it can cause issues with locally installed versions (node project dependencies). For a localised and project-dependent kipper installation add kipper to your package.json.

Add Kipper to your project

This steps requires that you have a working node project already setup and ready to be used. If you don't have one yet, you can simply do the following to create a new package:

npm init

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

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

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

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

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

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

For yarn, you can also use:

yarn kipper