Stanley

Self-contained git-based local directory package manager for Lua.

Installation

Requirements

• *nix system
• git discoverable with which git command
• Lua at least 5.2.4

Per project installation

1. Download stanley to project directory.
2. Issue ./stanley init command.

Global installation

1. Put stanley under one of the directories from $PATH variable.

If working directory is not automatically detected, then please consider using first option

Usage

Usage: stanley [options] command [repo]

Available commands:

    dump        Generate ./lib/autoload.lua file.
    help        Show this message.
    init        Create package.yaml in current working directory.
    install     Alias for: stanley update && stanley dump
    remove      Remove package from required list.
    require     Add package to required list.
    update      Clone or pull all required packages from remote sources.

Available options:

    --source, -s    Set source for newly required package.
                    Appended to every repository that does not have source specified.
                    type: string        default: https://github.com/

    --target, -t    Set target directory for newly required package.
                    Git clone will download files there.
                    type: string        default: 

    --verbose, -v   Enable verbose mode (print debug messages).
                    The higher the value, the deeper you dig.
                    type: number        default: 0

    --version       Print current version and exit.
                    type: boolean       default: false

Example usage scenarios

$ stanley init
$ stanley require user/example_repo
# require repo with the same name from another hosting source
$ stanley require user/example_repo --source https://another_hosting.io/
$ stanley update
$ stanley dump

$ cp /some/example/package.yaml ./package.yaml
$ stanley install # alias for: stanley update && stanley dump

package.yaml structure explanation here.

Additional features

Generated autoload.lua file contains additional functionalities. More about it here.

Building from source

Requirements

• GNU Make
• Lua at least 5.2.4
• lexe

$ git clone https://github.com/Stanley-lua/Stanley.git
$ make

TODO

• Fix bugs if any
• Resolve recurrent package dependencies.
• Add functionality for currently unused fields.