Skip to content

inklang/quill

Repository files navigation

quill

The package manager for Ink — a scripting language for Paper Minecraft servers.

Install

cargo install --git https://github.com/inklang/quill

Getting started

Create a new project and start writing scripts:

quill new my-project
cd my-project
quill add ink.mobs
quill build
quill run

Commands

Project setup

quill new <name>                # create a new project (--kind script|library)

Dependencies

quill add <package>             # add a dependency
quill remove <package>          # remove a dependency
quill install                   # install all dependencies
quill update [packages...]      # update dependencies
quill outdated                  # check for newer versions
quill why <package>             # show why a package is installed
quill ls                        # list installed packages

Building

quill build                     # compile grammar and Ink scripts
quill build --full              # force full recompilation
quill compile                   # compile Ink scripts
quill check                     # check for errors without building
quill watch                     # watch for changes and rebuild
quill run                       # build, deploy, and run a Paper dev server
quill run --no-watch            # start without file watching
quill pack                      # create a package tarball
quill clean                     # clean build artifacts

Registry

quill login                     # login to the registry
quill login --token <tok> --username <user>  # token-only login (CI)
quill logout                    # remove credentials
quill publish                   # publish your package
quill unpublish [version]       # remove a published version
quill search <query>            # search the registry
quill info <package>            # show package details

Cache

quill cache info                # show cache info
quill cache ls                  # list cached packages
quill cache clean               # clean cache

Diagnostics

quill audit                     # audit for vulnerabilities
quill doctor                    # run diagnostics
quill completions [shell]       # generate shell completions

Lockfile

quill.lock is automatically created and updated by add, install, and update. It ensures reproducible installs by pinning exact versions. Commit it to version control.

Configuration

Point quill at a different registry:

export LECTERN_REGISTRY=https://lectern.inklang.org

Or set it in ~/.quillrc:

{ "token": "...", "registry": "https://lectern.inklang.org" }

Development

cargo build                     # debug build
cargo build --release           # optimized build
cargo test                      # run tests

About

quill — package manager for inklang

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages