slp/README.md

2.0 KiB

slp

SLope Package manager.

An easy way to install, remove, and update slope packages.

slp docs      [[-g]]  [module]    # open a module's readme in $PAGER
slp gen                           # creates new module dir/skeleton
slp help                          # print usage information
slp install   [[-g]]  [module...] # installs module(s)
slp installed [[-g]]              # lists all installed packages
slp list                          # lists all available packages
slp remove    [[-g]]  [module...] # removes module(s)
slp search            [term...]   # searches for modules
slp show              [module...] # shows details for module(s)
slp update    [[-g]]  [module...] # updates module(s)

Global installs

Operations that accept a -g flag will attempt to install a module systemwide (this may require root access). A --global flag may be passed in lieu of a -g flag if desired for clarity.

The install location for global modules is: /usr/lib/slope/modules

Globals modules must be dealt with separately from local modules and cannot be combined in a single command.

Note that early versions of slope to not search the global module path. If you have installed modules globally on your system and are unable to use load-mod to access them: update your slope version.

Adding new packages

Packages can be registered in the repository at https://git.rawtext.club/slope-lang/packages by submitting a PR to that repository. If you are unsure of how to proceed feel free to open an issue at said repository instead, with a link to your module's source code.

Notes

A note on module versioning: At present, slp does not handle any versioning and will always grab the newest version of a module, while update will always update to the newest. There are plans in place to declare a module release via the release's tag value: module-name@tag (ex. ini@0.2.1). Stay tuned for an announcement that that has been added. In the meantime: good fortune and safe journeys in the wilderness.