Shard Detail

spark v1.14.3

A command line prompt and file management tool for Crystal apps

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development


spark:
  github: stephendolan/spark

Readme

Spark

Shard CI API Documentation Website GitHub release

Installation

Add the dependency to your shard.yml:

dependencies:
  spark:
    github: stephendolan/spark

Run shards install

Library usage

Require the shard:

require "spark"

Then, use any of the fully documented modules below to interact with your user:

Command line usage

Spark ships with a command line interface, installed in a postinstall step when you shards install. The resulting binary will be located at ./bin/spark.

With this CLI installed, you have access to the following commands:

  • ./bin/spark apply [Remote Template URL] - Runs the content returned from the provided URL through crystal run
  • ./bin/spark apply --local [Local File Path] - Runs the content of the provided file path through crystal run

Development

  1. Add your code
  2. Ensure specs pass with crystal spec
  3. Ensure correct formatting with crystal tool format --check
  4. Ensure correct style with ./bin/ameba

Contributing

  1. Fork it (https://github.com/stephendolan/spark/fork)
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Credits & Inspirations

  • TTY because of the excellent code and organization
  • Thor because I've loved using it with Ruby and Rails
  • Ameba because of their excellent shard CLI

Contributors