Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brettlangdon/tend
CLI Tool to run a command when files in a directory have changed
https://github.com/brettlangdon/tend
Last synced: 3 months ago
JSON representation
CLI Tool to run a command when files in a directory have changed
- Host: GitHub
- URL: https://github.com/brettlangdon/tend
- Owner: brettlangdon
- Created: 2014-05-27T14:45:03.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-06-24T17:04:15.000Z (over 10 years ago)
- Last Synced: 2024-10-07T01:48:05.753Z (3 months ago)
- Language: JavaScript
- Size: 234 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
tend
====
[](http://badge.fury.io/js/tend)
Quick and easy cli command to watch a directory for file changes and run a
provided command when any files have been changed, removed or added.
## Installation
```bash
npm install -g tend
```
## Usage
```
Usage:
tend
tend
tend [--restart] [--start] [--ignoreHidden] [--filter ] [ ]
tend (--help | --version)
Options:
-h --help Show this help text
-v --version Show tend version information
-r --restart If is still running when there is a change, stop and re-run it
-i --ignoreHidden Ignore changes to files which start with "."
-f --filter Use regular expression to filter which files trigger the command
-s --start Run as soon as tend executes
```
```bash
tend --restart --ignoreHidden ./ "node server.js"
```
### Options
#### tend
Running `tend` with no cli arguments will try to load your `.tendrc` file and start from any configuration set in that
#### tend \
`tend` will try to load your `.tendrc` file and run the command provided in the section ``. It will run the command
once and will not watch for changes in `directory`.
#### tend [--restart] [--start] [--ignoreHidden] [--filter \] [\ \]
Run `tend` with options for a single directory/command from cli rather than loading options from `.tendrc`.
#### tend (--help | --version)
Show help/version information about `tend`
### .tendrc
`tend` can accept it's configuration from a `.tendrc` file rather than taking arguments from
the command line. Using `.tendrc` also allows you to run multiple instances of `tend` at once.
`.tendrc` files are parsed using [rc](https://github.com/dominictarr/rc).
```ini
; global settings
ignoreHidden=true
[js]
directory=./src
command=uglifyjs -o ./build/main.min.js ./src/*.js
[app]
directory=./app
command=node ./app/server.js
restart=true
start=true
```
The above config will run two instances of `tend`:
```bash
tend --ignoreHidden ./src "uglifyjs -o ./build/main.min.js ./src/*.js"
# AND
tend --ignoreHidden --restart ./app "node ./app/server.js"
```
#### .tendrc Options
* `ignoreHidden` - ignore hidden folders
* `restart` - restart `command` if a file changes while the previous is still running
* `start` - start `command` when `tend` starts
* `directory` - the directory to watch for changes
* `filter` - regular expression filter for filenames which will trigger `command`
* `command` - the command to run when a file has changed
## License
```
The MIT License (MIT) Copyright (c) 2014 Brett Langdon (http://brett.is)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```