almandine

module
v0.2.0-alpha.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 13, 2025 License: MIT

README ΒΆ

Almandine – Lua Package Manager πŸ’Ž

License GitHub Actions Workflow Status Coverage Status GitHub last commit OpenSSF Scorecard OpenSSF Best Practices Go Report Card

A modern, cross-platform, developer-friendly package manager for Lua projects. Easily manage, install, and update Lua single-file dependencies..

Features

  • πŸ“¦ Easy Dependency Management: Add, remove, and update Lua single-file dependencies with simple commands.
  • πŸ”’ Reproducible Installs: Lockfiles ensure consistent environments across machines.
  • πŸ› οΈ Cross-Platform: Works on Linux, macOS, and Windows.

πŸš€ Installation

You can install almd by running the following commands in your terminal. These scripts will download and run the appropriate installer for your system from the main branch of the official repository.

macOS/Linux Install
curl -LsSf https://raw.githubusercontent.com/nightconcept/almandine/main/install.sh | sh
Windows Install
powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/nightconcept/almandine/main/install.ps1 | iex"

Requirements

macOS/Linux Requirements
Windows Requirements

Note: These can all be installed via Scoop.

Usage

almd init                # Create a new Lua project
almd add <package>       # Add a dependency
almd remove <package>    # Remove a dependency
almd install             # Install dependencies
almd list                # List installed dependencies
almd self update         # Update almd

Tasks

Project tasks are managed using go-task. You can list available tasks with task --list.

License

This project is licensed under the MIT License. See LICENSE for details.

Directories ΒΆ

Path Synopsis
cmd
almd command
internal
cli/add
Package add implements the 'add' command for Almandine CLI.
Package add implements the 'add' command for Almandine CLI.
cli/install
Package install implements the dependency installation functionality.
Package install implements the dependency installation functionality.
cli/list
Package list implements the 'list' command for displaying project dependencies and their status.
Package list implements the 'list' command for displaying project dependencies and their status.
cli/remove
Package remove handles project dependency removal operations
Package remove handles project dependency removal operations
cli/self
Package self provides self-management functionality for the almd CLI application.
Package self provides self-management functionality for the almd CLI application.
core/downloader
Package downloader provides functionality to download files from URLs.
Package downloader provides functionality to download files from URLs.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL