CLI

Coal exposes an easy-to-use API via its command-line interface.

CLI help

At any time you can see helpful Coal CLI info with the following commands:

        coal help
        coal build -h, --help
        coal serve -h, --help
    

CLI Overview

        A static HTML development tool, built with Rust
        USAGE:
            coal [SUBCOMMAND]

        FLAGS:
            -h, --help       Prints help information
            -V, --version    Prints version information

        SUBCOMMANDS:
            build    Build project for deployment
            help     Prints this message or the help of the given subcommand(s)
            serve    Serve project for local development
    

Serve HTML

        Serve project for local development
        USAGE:
            coal serve [OPTIONS]

        FLAGS:
            -h, --help       Prints help information
            -V, --version    Prints version information

        OPTIONS:
            -p, --port <port>        the port to run the dev server on [default: 8041]
            -s, --source <source>    the folder to use in Coal [default: src]
    

Build HTML

        Build project for deployment

        USAGE:
            coal build [OPTIONS]
        
        FLAGS:
            -h, --help    Prints help information
        
        OPTIONS:
            -d, --dest <dest>          the folder to compiled public assets to [default: dist]
            -r, --root <root>          the folder root to insert before assets [default: ]
            -s, --source <source>      the folder to use in Coal [default: src]
            -v, --version <version>    the build to insert into html [default: 0.1.0]