# creep

> Crawls metadata in files and directories

Latest version **0.2.2** (published 2014-04-16) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

Provides the command `creep`.

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.2.2 |
| Published | 2014-04-16 |
| First published | 2014-04-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+12 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | justinvdm |
| Maintainers | justinvdm |
| Keywords | metadata, find, fs |

## Links

- npm: https://www.npmjs.com/package/creep
- Repository: git@github.com:justinvdm/creep
- Homepage: https://github.com/justinvdm/creep
- Issues: https://github.com/justinvdm/creep/issues
- npm.io page: https://npm.io/package/creep

## Dependencies (8)

- [q](https://npm.io/package/q.md) ~1.0.0
- [q-io](https://npm.io/package/q-io.md) ~1.11.0
- [lodash](https://npm.io/package/lodash.md) ~2.4.1
- [matter](https://npm.io/package/matter.md) ~0.2.0
- [js-yaml](https://npm.io/package/js-yaml.md) ~3.0.2
- [commander](https://npm.io/package/commander.md) ~2.1.0
- [tea-merge](https://npm.io/package/tea-merge.md) ~0.1.0
- [coffee-script](https://npm.io/package/coffee-script.md) ~1.7.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 0.2.2 (latest) — 2014-04-16
- 0.2.1 — 2014-04-13
- 0.2.0 — 2014-04-13
- 0.1.2 — 2014-04-13
- 0.1.1 — 2014-04-13
- 0.1.0 — 2014-04-13

## README

# creep

crawls metadata in files and directories.

```sh
$ creep "'microscopic' in tags or 'rainbows' in tags"  
a.md
b.js
```


## installation
```sh
# npm install -g creep
```


## usage

add front matters to the files you want to be searchable:

*a.md*:

```
---
tags:
  - rainbows
  - earthworms
---

# there are rainbows
and earthworms
```

*b.js*:

```javascript
// ---
// tags:
//   - microscopic
//   - hummingbirds
// ---

console.log('and microscopic hummingbirds');
```

then just query the metadata:

```sh
$ creep "'microscopic' in tags or 'rainbows' in tags"  
a.md
b.js
```

creep uses [coffeescript](http://coffeescript.org/) as the query language, but alternatives can be plugged in. [lodash](http://lodash.com/) is available in queries as `_`.

creep looks for the first of the following metadata files in the directories it crawls, recursively merging the metadata into child directory and file metadata:

  - `.creep.yml`
  - `.creep.yaml`
  - `creep.yml`
  - `creep.yaml`
  - `.creep.json`
  - `creep.json`


## config
creep's uses the config defaults given in [`creep.config`](src/config.js), then merges these defaults with the first of these configs that it finds:

  - `./.creeprc.yml`
  - `./.creeprc.yaml`
  - `./.creeprc.json`
  - `$HOME/.creeprc.yml`
  - `$HOME/.creeprc.yaml`
  - `$HOME/.creeprc.json`

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