# sore

> Shell core functions

Latest version **0.1.0** (published 2024-04-17) · ISC license · 0 weekly downloads

## Install

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

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2024-04-17 |
| First published | 2019-01-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 12.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | YounGoat |
| Maintainers | youngoat |
| Keywords | shell |

## Links

- npm: https://www.npmjs.com/package/sore
- Repository: https://github.com/YounGoat/sore
- Issues: https://github.com/YounGoat/sore/issues
- npm.io page: https://npm.io/package/sore

## Dependencies (3)

- [noda](https://npm.io/package/noda.md) ^0.5.0
- [obtions](https://npm.io/package/obtions.md) ^0.1.0
- [undertake](https://npm.io/package/undertake.md) ^0.0.4

## Recent versions

- 0.1.0 (latest) — 2024-04-17
- 0.0.3 — 2019-03-31
- 0.0.2 — 2019-02-14
- 0.0.1 — 2019-01-29

## README

#	sore

The package name "sore" may be interpreted as character-reversed "Eros" who is ["the Greek god of sensual love and desire"][1]. Another way to remember the name is to regard it as the combination of "shell" and "core". This is my way!

![Shell Core][0]

__This package is a collection.__ Depending on this package, you may develop in Node.js with APIs which offer functions similiar with basic / frequently-used \*nix commands.

##	Table of Contents

* [Get Start](#get-start)
* [API](#api)
* [References](#references)

##	Get Start

Require all sub-modules at once.
```javascript
const sore = require('sore');

sore.find({
	basepath: '/var/log',
	type: 'd',
}, (err, data) => {
	// ...
});
```

Or, require specified sub module directly.
```javascript
const find = require('sore/find');

find({
	basepath: '/var/log',
	type: 'd',
}, (err, data) => {
	// ...
});
```

##	API

Most of sub modules are designed to be asynchronous and conform to [PoC][2] pattern. Here are available sub modules：
*	[find](docs/find.md)

##	References

[0]: docs/sore.png
[1]: https://en.wikipedia.org/wiki/Eros
[2]: https://github.com/YounGoat/articles/blob/master/2019/PoC.md

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