Skip to content

fuseraft/kiwi

Repository files navigation

Kiwi 🥝

Kiwi is a modern, lightweight scripting language built for expressiveness and utility.

Installation

Linux / macOS — one-liner installer:

curl -sSL https://raw.githubusercontent.com/fuseraft/kiwi/main/install.sh | bash

Windows — run in PowerShell:

irm https://raw.githubusercontent.com/fuseraft/kiwi/main/install.ps1 | iex

Both installers build Kiwi from source (requires the .NET 8 SDK) and add kiwi to your PATH. Open a new terminal and you're ready:

kiwi --help

Installer options

Flag Description
--user Install for current user only — ~/.kiwi (default)
--system Install system-wide — /opt/kiwi, symlinked to /usr/local/bin
--prefix=PATH Install to a custom directory
--url=URL Download a pre-built binary instead of building from source
--update Update to the latest version
--uninstall Remove Kiwi from the system
# Examples
./install.sh --system          # system-wide install (Linux/macOS)
./install.sh --prefix=/usr/local
./install.sh --uninstall

Manual install (build from source)

git clone https://github.com/fuseraft/kiwi.git
cd kiwi
./build.sh

Docker

docker build -t kiwi .
docker run --rm -v $(pwd):/scripts kiwi /scripts/hello.kiwi

Visual Studio Code Integration

For syntax highlighting and code snippets in VS Code, install the Kiwi language extension.

Open VS Code, launch Quick Open (Ctrl+P), paste the following command, and press Enter:

ext install fuseraft.kiwi-lang

Documentation

The docs provide comprehensive information on language features, usage, and the standard library.

There are also some examples you can run!

Test Suite

Explore the test suite for a variety of test cases. To run the test suite:

$ kiwi tests/test

Contributing

Contributions are highly appreciated! Here’s how to get involved:

  1. Join the Discussion: Join the community on Discord.
  2. Fork the Repository: Fork Kiwi on GitHub.
  3. Clone the Repository: Clone your forked copy to your machine.
  4. Set Up Your Environment: Follow the steps in "Getting Started."
  5. Make Changes: Implement new features or fix issues.
  6. Test Your Changes: Run all tests to ensure stability.
  7. Submit a Pull Request: Submit your changes for review.

For more details, please refer to CONTRIBUTING.md.

License

This project is licensed under the MIT License.

About

Kiwi 🥝

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors