Kipper CLI - @kipper/cli 🦊✨

The Kipper command line interface (CLI) to interact with the Kipper compiler. ⌨️✨

Kipper is a JavaScript-like strongly and strictly typed language with Python flavour. It aims to provide straightforward, simple, secure and type-safe coding with better efficiency and developer satisfaction!

It compiles to both JavaScript and TypeScript, and can be set up in your terminal, Node.js or ES6+ browser. 🦊💻

For more details, you can read more about this project on the project repository and the Kipper website.

• Kipper CLI - @kipper/cli 🦊✨
• Usage
• Commands

General Information

• Website: https://kipper-lang.org
• Docs: https://docs.kipper-lang.org
• Playground: https://play.kipper-lang.org
• Issue Tracker: https://issues.kipper-lang.org
• Roadmap: View Kipper Roadmap 🦊🚧
• Changelog: View CHANGELOG.md

Usage

$ npm install -g @kipper/cli
$ kipper COMMAND
running command...
$ kipper (--version)
@kipper/cli/0.12.0 linux-x64 node-v20.15.0
$ kipper --help [COMMAND]
USAGE
  $ kipper COMMAND
...

Commands

• kipper compile [FILE]
• kipper help [COMMAND]
• kipper new [LOCATION]
• kipper run [FILE]
• kipper version

kipper compile [FILE]

Compile a Kipper program into the specified target language.

USAGE
  $ kipper compile [FILE]

ARGUMENTS
  FILE  The file that should be compiled. Takes precedence over the 'string-code' flag and the config file.

OPTIONS
  -b, --[no-]optimise-builtins   Optimise the generated built-in functions using tree-shaking to reduce the size of the
                                 output.

  -d, --[no-]dry-run             Run the compiler without writing any output. Useful for checking for errors.

  -e, --encoding=encoding        The encoding that should be used to read the file (ascii,utf-8,utf8,utf16le).

  -i, --[no-]optimise-internals  Optimise the generated internal functions using tree-shaking to reduce the size of the
                                 output.

  -o, --output-dir=output-dir    The build directory where the compiled files should be placed. If the path does not
                                 exist, it will be created. Takes precedence over the config file, defaults to 'build'
                                 if both are not provided

  -s, --string-code=string-code  The content of a Kipper file that can be passed as a replacement for the 'file'
                                 parameter. Takes precedence over the config file.

  -t, --target=js|ts             The target language where the compiled program should be emitted to.

  -w, --[no-]warnings            Show warnings that were emitted during the compilation.

  --[no-]log-timestamp           Show the timestamp of each log message.

  --[no-]recover                 Recover from compiler errors and log all detected semantic issues.

EXAMPLES
  kipper compile -t js
  kipper compile -t ts -s "print('Hello, World!');"
  kipper compile -t js -e utf8 -o build/ -s "print('Hello, World!');"
  kipper compile -t ts -o build/ -e utf8 -s "print('Hello, World!');"
  kipper compile -t js -o build/ -e utf8 -s "print('Hello, World!');" --warnings
  kipper compile -t ts -o build/ -e utf8 -s "print('Hello, World!');" --warnings --log-timestamp
  kipper compile -t js ./path/to/file.kip
  kipper compile -t ts ./path/to/file.kip -o build/ --log-timestamp
  kipper compile -t js ./path/to/file.kip -o build/ --warnings --log-timestamp
  kipper compile -t ts ./path/to/file.kip -o build/ -e utf16le --warnings --log-timestamp

See code: src/commands/compile.ts

kipper help [COMMAND]

Display help for the Kipper CLI.

USAGE
  $ kipper help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: src/commands/help.ts

kipper new [LOCATION]

Generate a new Kipper project with a kip-config.json using a setup wizard.

USAGE
  $ kipper new [LOCATION]

ARGUMENTS
  LOCATION  [default: .] The directory where the new project should be created.

OPTIONS
  -d, --default  Use the default settings for the new project. Skips the setup wizard.

See code: src/commands/new.ts

kipper run [FILE]

Compile and execute a Kipper program.

USAGE
  $ kipper run [FILE]

ARGUMENTS
  FILE  The file that should be compiled and run.

OPTIONS
  -b, --[no-]optimise-builtins   Optimise the generated built-in functions using tree-shaking to reduce the size of the
                                 output.

  -e, --encoding=encoding        The encoding that should be used to read the file (ascii,utf-8,utf8,utf16le).

  -i, --[no-]optimise-internals  Optimise the generated internal functions using tree-shaking to reduce the size of the
                                 output.

  -o, --output-dir=output-dir    The build directory where the compiled files should be placed. If the path does not
                                 exist, it will be created.

  -s, --string-code=string-code  The content of a Kipper file that can be passed as a replacement for the 'file'
                                 parameter.

  -t, --target=js|ts             The target language where the compiled program should be emitted to.

  -w, --[no-]warnings            Show warnings that were emitted during the compilation.

  --[no-]log-timestamp           Show the timestamp of each log message.

  --[no-]recover                 Recover from compiler errors and display all detected compiler errors.

EXAMPLES
  kipper run -t js
  kipper run -t ts -s "print('Hello, World!');"
  kipper run -t js -e utf8 -o build/ -s "print('Hello, World!');"
  kipper run -t ts -o build/ -e utf8 -s "print('Hello, World!');"
  kipper run -t js -o build/ -e utf8 -s "print('Hello, World!');" --warnings
  kipper run -t ts -o build/ -e utf8 -s "print('Hello, World!');" --warnings --log-timestamp

See code: src/commands/run.ts

kipper version

Display the currently installed Kipper version.

USAGE
  $ kipper version

See code: src/commands/version.ts

Contributing to Kipper

If you want to contribute to Kipper, we have a full guide explaining the structure of Kipper and how to use GitHub issues and pull requests. Check it out here!

If you have any questions or concerns, you can open up a discussion page here!

We appreciate any feedback or help! Kipper is open-source and free for anyone, help us make it even better! 🦊❤️

Copyright and License

Copyright (C) 2021-2024 Luna Klatzer

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

See the LICENSE for information on terms & conditions for usage.

FOSSA License Report