@wndrfl/static-kit-cli

✨ Static Kit CLI

A commandline interface for bootstrapping and working with Wonderful's Static Kit library.

Table of Contents

1. Documentation
   1. Installation
   2. Commands
2. Support
3. Known issues
4. License

Documentation

Installation

Using npm:

$ npm install -g @wndrfl/static-kit-cli

Commands

The Static Kit CLI provides different commands for many common tasks, as they pertain to interfacing with the Static Kit library.

statickit install [-d --dir] [-i --init]

Installs the Static Kit library into the current directory (or, optionally, a directory indicated by the --dir flag). If the --init flag is provided, the CLI will automatically run commands such as npm install within the new installation.

statickit compile [all|js|css|images] [-d --dir]

Compiles source Javascript, CSS (SCSS), and image files into distributable files. The command uses the .staticrc file to understand where to find the source files and where to output the distribution files.

statickit template [create] [-n --name] [-d --dir]

Creates a pair of .js and .scss files within the Static Kit directory. Use this command when beginning work on static assets (JS / CSS) for a new page template.

Support

The CLI has been tested on the following tools. Please let us know if how it works in your environment!

• Mac OS:
  • Terminal.app
  • iTerm
• Windows:
  • (needs testing, please let us know how it works!)
• Linux:
  • (needs testing, please let us know how it works!)

Known Issues

Currently there are no known issues. However, if you experience something, we certainly want to know! Please submit a Github issue.

License

Copyright (c) 2023 Wonderful Licensed under the MIT license.

Collaborators

• Johnnie Munger [e-mail]