# guard-cane

**Repository Path**: mirrors_guard/guard-cane

## Basic Information

- **Project Name**: guard-cane
- **Description**: Automatically run Cane when files change
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-08
- **Last Updated**: 2026-06-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Guard::Cane
[![Build Status](https://travis-ci.org/guard/guard-cane.png?branch=master)](https://travis-ci.org/guard/guard-cane)
[![Gem Version](https://badge.fury.io/rb/guard-cane.png)](http://badge.fury.io/rb/guard-cane)

Guard::Cane automatically runs [Cane](https://github.com/square/cane#usage)
when files change.

## Installation

Put this in your Gemfile:

```rb
group :development
  gem 'guard-cane'
end
```

And then install with:

```sh
$ bundle
$ guard init cane
```

This will place the following in your `Guardfile`:

```rb
guard :cane do
  watch(%r{^(.+)\.rb$})
end
```

It's also recommended to add a `.cane` file to your project:

```
--abc-max 10
--no-doc
--style-exclude spec/**/*
```

See [square/cane](https://github.com/square/cane#usage) for detailed usage.