Skip to content

Rune's Package Manager

Chisel is a package manager for Rune. It is a way to install packages from either Git repositories or from the Chisel package registry.

How it works

Chisel comes bundled with Rune, it installs, manages and removes packages for you, and allows Rune to resolve packages by name instead of path. To find packages go to the Chisel package registry, or you can install packages from Git repositories. Chisel will also manage dependencies for you, so if a package you install has dependencies, Chisel will automatically install those as well.

Creating a project

To create a new project, you can use the following command:

./Rune chisel init <project-name>

Installing packages

To install a package from the Chisel package registry, you can use the following command:

./Rune chisel install <package-name>

To install a package from a Git repository, you can use the following command:

./Rune chisel install <git-repository-url>

Removing packages

To remove a package, you can use the following command:

./Rune chisel remove <package-name>

Updating packages

To update a package, you can use the following command:

./Rune chisel update <package-name>

Updating all packages

To update all packages, you can use the following command:

./Rune chisel update-all

Using the Chisel package registry

The Chisel package registry is a website containing packages uploaded by the community that can be easily installed using Chisel. To find packages, go to the Chisel package registry, and search for the package you want to install. Then run the install command given with ./Rune replaced with the path to your Rune executable. To upload a package, simply create an account, click the upload button and fill out the form. It will ask for a Git repo URL among other things. You can remove or manage your packages from the account dashboard as well.

Using packages in your code

To use a package in your code, you can import it using the import statement. For example, if you installed a package called my-package, you can import it like this:

import Chisel:my_package/my_file.rn;

This will import the file as if it were a path to that file, making it easy to use packages without needing paths or complicated downloads.