`wolfram-cli`

CLI Documentation | Changelog | Contributing

About

An unofficial Wolfram command-line interface.

Usage

Installing `wolfram-cli`

This project is a development prototype, and must be build from source manually.

To install the wolfram-cli command-line tool, first clone this repository:

$ git clone https://github.com/ConnorGray/wolfram-cli

Next, install the ConnorGray/WolframCLI paclet locally by executing:

$ ./wolfram-cli/scripts/install-paclet.wls

Finally, install the wolfram-cli executable by invoking cargo:

$ cargo install --path ./wolfram-cli/crates/wolfram-cli

Verify the installation by executing:

$ wolfram-cli

Which should open an interactive REPL interface.

Features

Run paclet tests from the command-line

See also: $ wolfram-cli paclet test

Add custom subcommands via "WolframCLI" paclet extensions

Given an installed paclet that declares the following extension:

PacletObject[<|
    ...,
    "Extensions" -> {
        ...,
        {"WolframCLI",
            "Subcommand" -> "travel-directions",
            "HandlerFunction" -> "MyPackage`HandleTravelDirectionsSubcommand"
        }
    }
|>]

then $ wolfram-cli travel-directions will be handled by the HandleTravelDirectionsSubcommand[..] function:

See examples/TravelDirectionsCLI for the complete example.

Contributing

See Development.md for instructions on how to perform common development tasks.

See Maintenance.md for instructions on how to maintain this project.