An open API service indexing awesome lists of open source software.

https://github.com/fuseraft/kiwi

The Kiwi Programming Language πŸ₯
https://github.com/fuseraft/kiwi

dotnet language programming-language

Last synced: 2 months ago
JSON representation

The Kiwi Programming Language πŸ₯

Awesome Lists containing this project

README

          

# Kiwi πŸ₯

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

## Installation

**Linux / macOS** β€” one-liner installer:
```bash
curl -sSL https://raw.githubusercontent.com/fuseraft/kiwi/main/install.sh | bash
```

**Windows** β€” run in PowerShell:
```powershell
irm https://raw.githubusercontent.com/fuseraft/kiwi/main/install.ps1 | iex
```

Both installers build Kiwi from source (requires the [.NET 9 SDK](https://dotnet.microsoft.com/download/dotnet/9.0)) and add `kiwi` to your PATH. Open a new terminal and you're ready:
```bash
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 |

```bash
# Examples
./install.sh --system # system-wide install (Linux/macOS)
./install.sh --prefix=/usr/local
./install.sh --uninstall
```

### Manual install (build from source)

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

### Docker

```bash
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](https://marketplace.visualstudio.com/items?itemName=fuseraft.kiwi-lang).

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

```
ext install fuseraft.kiwi-lang
```

## Package Manager

[Zest](https://github.com/fuseraft/zest) is the official package manager for Kiwi.
Install community packages directly from GitHub with semver constraints and a lock file.

```bash
zest install owner/repo
```

## Documentation

The [docs](docs/README.md) provide comprehensive information on language features, usage, and the [standard library](docs/lib/README.md).

There are also some [examples](/examples/) you can run!

## Test Suite

Explore the [test suite](tests/lib/suite) for a variety of test cases. To run the test suite:

```shell
$ kiwi tests/test
```

## Contributing

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

1. **Join the Discussion**: Join the community on [Discord](https://discord.gg/9PW3857Bxs).
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](CONTRIBUTING.md).

## License

This project is licensed under the [MIT License](LICENSE).