mardlib

mardlib | My Arduino Libraries

Install Arduino Libraries from source folders.

Overview

Arduino IDE only works reliably with linked modules located in the global libraries folder. To reuse modular code between projects, they must transition from locally installed development files to globally installed resources.

mardlib locates the global library folder and links or copies local library projects to it. You can think of it as npm link or npm install -g, but for Arduino IDE / libraries.

Installation

npm install -g mardlib

Usage

  Usage: mardlib [options]

  Options:

    -h, --help             output usage information
    -V, --version          output the version number
    -f, --force            Ignore all errors and attempt all operation.
    -l, --library [value]  An Arduino library folder
    -d, --dest [value]     (Optional) The target location for copy/install.
    --mode [mode]          `link` for sym-link (default) or `copy` for copy.
    --dry-run              Describe operation, but do not copy
    --no-summary           Dont write the summary (only operation results).
    --replace              Replace if already installed.

TODO

• Also include command syntax: i.e. mardlib install and mardlib link
• support git repository urls
• have an explicit -r [library] command which removes specific library(s) from dest.
• have a command to just echo the arduino library.