# crontab

> A module for reading, creating, deleting, manipulating, and saving system cronjobs with node.js

Latest version **1.4.2** (published 2021-05-07) · 0 weekly downloads

## Install

```sh
npm install crontab
pnpm add crontab
yarn add crontab
bun add crontab
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.4.2 |
| Published | 2021-05-07 |
| First published | 2010-12-27 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Unpacked size | 72.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 188 |
| Author | Blagovest Dachev |
| Maintainers | blago |
| Keywords | cron, crontab, schedule, system, run, process |

## Links

- npm: https://www.npmjs.com/package/crontab
- Repository: https://github.com/dachev/node-crontab
- Issues: https://github.com/dachev/node-crontab/issues
- npm.io page: https://npm.io/package/crontab

## Dependencies (1)

- [underscore](https://npm.io/package/underscore.md) ^1.6.0

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 1.4.2 (latest) — 2021-05-07
- 1.4.1 — 2021-01-13
- 1.4.0 — 2020-08-31
- 1.3.0 — 2019-11-17
- 1.2.0 — 2018-09-09
- 1.1.4 — 2018-08-10
- 1.1.3 — 2016-06-27
- 1.1.2 — 2015-11-09
- 1.1.1 — 2015-11-09
- 1.1.0 — 2015-06-27
- 1.0.3 — 2015-06-23
- 1.0.2 — 2014-09-01
- 1.0.1 — 2014-06-20
- 1.0.0 — 2014-05-18
- 0.3.4 — 2013-05-19
- … 22 more at https://npm.io/package/crontab/versions

## README

# node-crontab
[![Build Status](https://secure.travis-ci.org/dachev/node-crontab.png)](http://travis-ci.org/dachev/node-crontab)
[![Dependencies](https://david-dm.org/dachev/node-crontab.png)](https://david-dm.org/dachev/node-crontab)
[![NPM version](https://badge.fury.io/js/crontab.svg)](http://badge.fury.io/js/crontab)

A module for creating, reading, updating, and deleting system cron jobs

## Installation

```bash
$ npm install crontab
```

## Examples
### Working with jobs
```js
require('crontab').load(function(err, crontab) {
  // create with string expression
  var job = crontab.create('ls -la', '0 7 * * 1,2,3,4,5');

  // create with Date
  var job = crontab.create('ls -lh', new Date(1400373907766));

  // create with comment
  var job = crontab.create('ls -lt', null, 'comment 2');

  // create special: @reboot, @hourly, @daily, @weekly, @monthly, @yearly, @annually, @midnight
  var job = crontab.create('ls -la', '@reboot');

  // check valid
  var job = crontab.create();
  if (job == null) {
    console.log('failed to create job');
  }

  // remove object
  var job = crontab.create('ls -lr', '0 7 * * 1,2,3,4,5', 'comment 3');
  crontab.remove(job);

  // remove conditions
  crontab.remove({command:'ls -lh', comment:/comment 2/});

  // manipulate: every business hour
  var job = crontab.create('ls -l');
  job.minute().at(0);
  job.hour().between(8, 17);
  job.dow().between('mon', 'fri');

  // manipulate: every other hour on weekday nights
  var job = crontab.create('ls -l');
  job.hour().between(19, 0).every(2);
  job.hour().between(0, 6).every(2);
  job.dow().between('mon', 'fri');
  
  // manipulate: summer
  var job = crontab.create('ls -l');
  job.month().between('jun', 'sep');
  
  // manipulate: Christmas
  var job = crontab.create('ls -l');
  job.minute().at(30);
  job.hour().at(9);
  job.dom().on(24);
  job.month().in('dec');

  // show all jobs
  var jobs = crontab.jobs();

  // show jobs with conditions
  var jobs = crontab.jobs({command:'ls -l', comment:/comment 1/});

  // reset jobs to their original state
  crontab.reset();

  // save
  crontab.save(function(err, crontab) {
  
  });

  console.log(crontab);
});
```

### Working with environment variables
```js
require('crontab').load(function(err, crontab) {
  // get all env variables
  var vars = crontab.vars();
  // find env variables by name
  var vars = crontab.vars({name: 'FOO'});
  // find env variables by value
  var vars = crontab.vars({val: 'bar'});
  // find env variables by name and value
  var vars = crontab.vars({name: 'FOO', val: 'bar'});
  // find env variables by name
  var vars = crontab.vars('FOO');

  // create with a pair of arguments
  crontab.vars().add('FOO', 'foo');
  // create multiple with an object argument
  crontab.vars().add({'FOO':'foo', 'BAR':'1'});

  // remove all env variables
  crontab.vars().rm();
  // remove selected env variables
  crontab.vars({name: 'FOO'}).rm();

  // save
  crontab.save(function(err, crontab) {

  });
});
```

### Naive reboot
```js
require('crontab').load(function(err, crontab) {
  if (err) {
    return console.error(err);
  }

  var command = 'ls -l';

  crontab.remove({command:command});
  crontab.create(command, '@reboot');

  crontab.save(function(err, crontab) {

  });
});
```

### More robust reboot and forever
```js
require('crontab').load(function(err, crontab) {
  if (err) {
    return console.error(err);
  }

  var uuid           = '64d967a0-120b-11e0-ac64-0800200c9a66';
  var nodePath       = process.execPath.split('/').slice(0, -1).join('/');
  var exportCommand  = 'export PATH=' + nodePath + ':$PATH';
  var foreverCommand = require('path').join(__dirname, 'node_modules', 'forever', 'bin', 'forever');
  var sysCommand     = exportCommand + ' && ' + foreverCommand + ' start ' + __filename;

  crontab.remove({comment:uuid});
  crontab.create(sysCommand, '@reboot', uuid);

  crontab.save(function(err, crontab) {
    console.log(err)
  });
});
```

### Specific user
```js
// when executing for another user the library uses sudo, unless the
// current process runs as root
require('crontab').load('alice', function(err, crontab) {
  if (err) {
    return console.error(err);
  }

  crontab.save(function(err, crontab) {
    console.log(err)
  });
});
```

## Author
Blagovest Dachev

## Copyright
* Blagovest Dachev (2010-2014)
* Martin Owens (2009-2012)

## Credits
This is a JavaScript port of a Python package by Martin Owens

## License
GPL3

---
_Source: https://npm.io/package/crontab · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._