kotlin-interactive-shell - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #typescript #llm #go #docker #windows #awesome #kubernetes #vue #awesome-list #pytorch

kotlin-interactive-shell

(★ 611)

Kotlin Language Interactive Shell

File Explorer

Download Latest Version (.zip)

- - build.yml
- - maven-wrapper.properties
- ki
- ki.bat
- ki.sh
- log4j.properties
- pom.xml
.gitignore
jreleaser.toml
LICENSE
mvnw
mvnw.cmd
pom.xml
README.md
set_default_release.sh

# Installation Guide

1. Get the code

git clone https://github.com/Kotlin/kotlin-interactive-shell

Downloads the entire project code from GitHub to your computer.

cd kotlin-interactive-shell

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended

Prerequisites

Homebrew A package manager for macOS/Linux.

brew install ki

Installs the pre-built package via Homebrew — no source build required.

✅ After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Maven (Java)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java projects.
Maven The build tool used for the mvn command.

mvn -DskipTests package

Installs dependencies and builds the project using Maven.

mvn -Dkotlin.version=1.4.10 -DskipTests package

Installs dependencies and builds the project using Maven.

✅ A BUILD SUCCESS message means it worked. The output is created under target/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Kotlin Language Interactive Shell

[![Kotlin Stable](https://kotl.in/badges/stable.svg)](https://kotlinlang.org/docs/components-stability.html)
[![JetBrains team project](https://jb.gg/badges/team.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
[![Maven Central](https://img.shields.io/maven-central/v/org.jetbrains.kotlinx/ki-shell.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.jetbrains.kotlinx%22%20AND%20a:%22ki-shell%22)

The shell is an extensible implementation of Kotlin REPL with a rich set of features including:

- Syntax highlight
- Type inference command
- Downloading dependencies in runtime using Maven coordinates
- List declared symbols

## History

The project is the former Sparklin shell migrated to the new Kotlin scripting and REPL infrastructure and converted to a
generic Kotlin Language Interactive Shell.

The Apache Spark adaptation of it is located in a separate [repository](https://github.com/Kotlin/kotlin-spark-shell).

The previous version of the Sparklin is accessible in the `sparklin` branch.

## Installation and Usage

### Manual

You can download archive from Maven Central: 
1. Go to [Releases](https://github.com/Kotlin/kotlin-interactive-shell/releases) page
2. Download desired version there
3. Unpack it to desired place
4. Launch `bin/ki.sh` for Linux/Mac or `bin\ki.bat` for Windows

### SDKMAN!

Install with [SDKMAN!](https://sdkman.io/) with the following command:

```bash
sdk install ki
```

After installation you can launch `ki` with either `ki` or `ki.sh` comman.

### Arch Linux

On Arch Linux, there's an [AUR package](https://aur.archlinux.org/packages/ki-shell-bin/) available.
After installation, you can run the shell through `ki`.

### Homebrew

Install with [Homebrew](https://brew.sh/) with the following command:
```bash
brew install ki
```

### MacPorts

Install with [MacPorts](https://www.macports.org) with the following command:
```bash
sudo port install ki-shell
```

## Build From Source

To build from source use:
```bash
git clone https://github.com/Kotlin/kotlin-interactive-shell
cd kotlin-interactive-shell
mvn -DskipTests package

```
It may be useful to build the project with a specific version of Kotlin. To do so use:
```bash
mvn -Dkotlin.version=1.4.10 -DskipTests package
```
To start the shell, run `bin/ki.sh` on Linux and macOS. On Windows, use `bin\ki.bat` instead.

To exit the shell, type `:q` or `:quit`.

## Adding maven repositories that require auth

The following options are supported:

```bash
:repository https://myrepo.org username=user password=pwd
:repository https://myrepo.org username:user password:pwd

:repository https:myrepo.org ./path/to/file
# properties file should contain
# username=john
# password=johnpwd
```