# @plastichub/osr-cli-commons

> ## Package verbs (todos)

Latest version **0.5.7** (published 2024-12-27) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install @plastichub/osr-cli-commons
pnpm add @plastichub/osr-cli-commons
yarn add @plastichub/osr-cli-commons
bun add @plastichub/osr-cli-commons
```

Provides the command `osr-cli`.

## Health

**Score 25/100 (F)** — status: maintenance-mode.

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

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

Negative: insecure dependencies; stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.7 |
| Published | 2024-12-27 |
| First published | 2022-10-02 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 14.0.0 |
| Dependencies | 20 |
| Unpacked size | 122.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | plastichubdev |
| Keywords | typescript |

## Links

- npm: https://www.npmjs.com/package/@plastichub/osr-cli-commons
- Repository: https://git.osr-plastic.org/plastichub/lib-content
- npm.io page: https://npm.io/package/@plastichub/osr-cli-commons

## Dependencies (20)

- [zod](https://npm.io/package/zod.md) ^3.23.8
- [glob](https://npm.io/package/glob.md) ^10.4.1
- [yaml](https://npm.io/package/yaml.md) ^2.6.0
- [p-map](https://npm.io/package/p-map.md) ^4.0.0
- [tslog](https://npm.io/package/tslog.md) ^4.9.3
- [yargs](https://npm.io/package/yargs.md) ^17.7.2
- [cryptr](https://npm.io/package/cryptr.md) ^6.0.3
- [env-var](https://npm.io/package/env-var.md) ^7.1.1
- [is-glob](https://npm.io/package/is-glob.md) ^4.0.3
- [fast-glob](https://npm.io/package/fast-glob.md) ^3.2.11
- [glob-base](https://npm.io/package/glob-base.md) github:justin-caribou/glob-base
- [zod-to-ts](https://npm.io/package/zod-to-ts.md) ^1.2.0
- [ansi-regex](https://npm.io/package/ansi-regex.md) ^5.0.0
- [parse-glob](https://npm.io/package/parse-glob.md) ^3.0.4
- [typescript](https://npm.io/package/typescript.md) ^5.6.3
- [@plastichub/fs](https://npm.io/package/@plastichub/fs.md) ^0.13.40
- [@plastichub/core](https://npm.io/package/@plastichub/core.md) ^0.2.6
- [zod-to-json-schema](https://npm.io/package/zod-to-json-schema.md) ^3.23.5
- [@plastichub/osr-log](https://npm.io/package/@plastichub/osr-log.md) ^0.1.2
- [@plastichub/osr-commons](https://npm.io/package/@plastichub/osr-commons.md) ^0.4.6

## Recent versions

- 0.5.7 (latest) — 2024-12-27
- 0.5.6 — 2024-12-25
- 0.5.5 — 2024-12-25
- 0.5.3 — 2024-12-25
- 0.5.2 — 2024-10-27
- 0.5.1 — 2024-07-05
- 0.5.0 — 2024-06-30
- 0.4.9 — 2024-06-11
- 0.4.8 — 2024-06-11
- 0.4.7 — 2024-06-11
- 0.4.6 — 2024-05-24
- 0.4.5 — 2024-02-18
- 0.4.4 — 2024-02-14
- 0.4.3 — 2023-12-03
- 0.4.2 — 2023-09-07
- … 22 more at https://npm.io/package/@plastichub/osr-cli-commons/versions

## README

# OSR CLI Commons

## Package verbs (todos)

Each package should expose information about itself, eg:

- info (package introspection)
- register context menu
- help
- help-json
- commands
- commands-json

For conversion related utility:

- provides (list of available conversions)
- provides-json

## Configuration example

```json

{
    "deepl": {
        "auth_key": "",
        "free_api": false
    },
    "cscart": {
        "apiKey": "",
        "apiUrl": "https://shop.osr-plastic.org/api/",
        "username": "",
        "userToken": "none"
    },
    "discourse": {
        "host": "https://forum.osr-plastic.org",
        "key": "",
        "username": "jerom",
        "rateLimitConcurrency": 1
    },
    "instagram": {
        "user": "cgoflyn@gmail.com",
        "token": ""
    },
    "urls":{
        "shop":"https://shop.osr-plastic.org/",
        "forum":"https://forum.osr-plastic.org/",
        "library":"https://kb.osr-plastic.org/",
        "git":"https://git.osr-plastic.org/",
        "assets":"https://assets.osr-plastic.org/"
    }
}
```

### References

- [Marked Terminal - Renderer](https://github.com/mikaelbr/marked-terminal)


### Todos

- [ ] CLI:Each
  - [ ] --list=Glob | String | Datasource
- [ ] Migrate FS Extras : npm | Opts | Validate

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