Popularity
9.6
Stable
Activity
0.0
Stable
275
9
23

Programming language: Crystal
License: MIT License
Tags: Misc    
Latest version: v0.0.5

guardian alternatives and similar shards

Based on the "Misc" category.
Alternatively, view guardian alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of guardian or a related project?

Add another 'Misc' Shard

README

๐Ÿ’‚ Guardian.cr

Guardian watches over your files and runs assigned tasks.

Guardian

Installation

OS X

brew tap f/guardian
brew install guardian

Arch Linux

Guardian is availabe as a package from the Arch User Repository called guardian-git

From Source

git clone https://github.com/f/guardian.git && cd guardian
crystal build src/guardian.cr --release

Quickstart

Crystal Libs

Guardian works seamless with Crystal Projects. It automatically binds itself to library you use.

$ crystal init lib yourlib
$ cd yourlib
$ guardian --init
Created guardian.yml of ./src/yourlib.cr

Non-Crystal Libs

You can use Guardian for other projects.

$ guardian --init
Created guardian.yml

Usage

$ guardian --init

It will create a guardian.yml file to use by Guardian.

guardian.yml

guardian.yml is a simple YAML file.

Simply it has YAML documents with seperated by --- line and each document has files and run keys.

files key needs a glob pattern, and run is a shell command what to run.

files: ./**/*.cr
run: crystal build ./src/guardian.cr
---
files: ./shard.yml
run: shards install

%file% Variable

Guardian replaces %file% variable in commands with the changed file.

files: ./**/*.txt
run: echo "%file% is changed"

Think you have a hello.txt in your directory, and Guardian will run echo "hello.txt is changed" command when it's changed.

Running Guardian

$ guardian
๐Ÿ’‚ Guardian is on duty!

Contributing

  1. Fork it ( https://github.com/f/guardian/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

Contributors

  • f Fatih Kadir Akฤฑn - creator, maintainer