• Kipper

    v0.12.1
  • Downloads

  • Docs

  • Playground

  • Changelog

  • Kipper

    v0.12.1
    • Downloads

    • Docs

    • Playground

    • Changelog

      • next /
      • Kipper API /
      • CLI /
      • Overview
    Kipper Docs
    • next
    • latest
    • 0.11.0
    • 0.10.4
    • 0.9.2
    • Overview

    • Quickstart

    • Goals for Kipper

    • Supported platforms

    • Usage Examples

      • Overview

    • Variables

      • Overview

      • String Type

      • Number Type

      • Boolean Type

      • Void Type

      • Null Type

      • Undefined Type

      • Array Type

      • Overview

      • Tangled Expression

      • Arithmetic Expression

      • Assignment Expression

      • Conditional Expressions

      • Logical Expressions

      • Bitwise Expression

      • Relational Expressions

      • Convert Or Cast Expression

      • F-String Expression

      • Member Access Expression

      • Function Call Expression

      • Lambda Expression

      • Matches Expression

      • Overview

      • Expression Statement

      • If Statement

      • While Loop

      • Do-While Loop

      • For Loop

      • Compound Statement

      • Jump Statement

    • Functions

    • Interfaces

    • Classes

    • Comments

    • Built-in Functions

      • Overview

      • Compiler Setup

        • Overview

          • index

          • compiler

          • errors

          • logger

          • utils

          • config

          • index

          • index

        • Overview

        • new

        • run

        • compile

        • help

        • version

      • next /
      • Kipper API /
      • CLI /
      • Overview
    • next /
    • Kipper API /
    • CLI /
    • Overview

    Edit page

    Kipper CLI API

    The Kipper CLI API describes the functionality of the Kipper CLI, which is provided by the @kipper/cli package. This is besides the Kipper Module API the only way to interact with the Kipper compiler.

    Unlike the programmatic API, the CLI can be interacted with using the command line. This is done by calling commands and passing flags (arguments) to the kipper command, which is per default available in your package or globally when the @kipper/cli package is installed.

    Usage

    $ npm install -g @kipper/cli
    $ kipper COMMAND
    running command...
    $ kipper (--version)
    @kipper/cli/0.11.0-rc.0 linux-x64 node-v18.18.2
    $ kipper --help [COMMAND]
    USAGE
      $ kipper COMMAND
    ...

    Available Commands

    • kipper new [LOCATION]: Initialises a new Kipper project.
    • kipper run [FILE]: Compiles and runs a Kipper program.
    • kipper compile [FILE]: Compiles a Kipper program to a target language.
    • kipper help [COMMAND]: Displays help information about the Kipper CLI.
    • kipper version: Displays the version of the Kipper CLI.
  • Developed at:

    • Releases
    • GitHub
    • Security
    • Issue Tracker
    • License
  • Copyright © 2021-2025 Luna Klatzer, 2024-2025 Lorenz Holzbauer & Fabian Baitura.
    Kipper is licensed under the GPL-3.0-or-later license.