# @openveo/api

> API for OpenVeo plugins

Latest version **8.2.0** (published 2023-02-27) · AGPL-3.0 license · 61 weekly downloads

## Install

```sh
npm install @openveo/api
pnpm add @openveo/api
yarn add @openveo/api
bun add @openveo/api
```

Provides the commands `ovWatch`, `ovRemove`, `ovDeployGithubPages`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 8.2.0 |
| Published | 2023-02-27 |
| First published | 2015-10-26 |
| Weekly downloads | 61 |
| License | AGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.3.0 |
| Dependencies | 21 |
| Unpacked size | 384.2 KB |
| Known vulnerabilities | 0 (+13 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Veo-Labs |
| Maintainers | maxime-beguin, openveo |
| Keywords | openveo, api, plugin, veo-labs |

## Links

- npm: https://www.npmjs.com/package/@openveo/api
- Repository: https://github.com/veo-labs/openveo-api
- Issues: https://github.com/veo-labs/openveo-api/issues
- npm.io page: https://npm.io/package/@openveo/api

## Dependencies (21)

- [gm](https://npm.io/package/gm.md) ^1.23.1
- [he](https://npm.io/package/he.md) ^1.2.0
- [nopt](https://npm.io/package/nopt.md) ^5.0.0
- [async](https://npm.io/package/async.md) ^3.2.0
- [multer](https://npm.io/package/multer.md) ^1.4.3
- [nanoid](https://npm.io/package/nanoid.md) ^3.1.23
- [tar-fs](https://npm.io/package/tar-fs.md) ^2.1.1
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.23
- [esprima](https://npm.io/package/esprima.md) ^4.0.1
- [mongodb](https://npm.io/package/mongodb.md) ^4.5.0
- [winston](https://npm.io/package/winston.md) ^3.3.3
- [passport](https://npm.io/package/passport.md) ^0.4.1
- [socket.io](https://npm.io/package/socket.io.md) ^4.2.0
- [imagemagick](https://npm.io/package/imagemagick.md) ^0.1.3
- [connect-mongo](https://npm.io/package/connect-mongo.md) ^4.6.0
- [passport-local](https://npm.io/package/passport-local.md) ^1.0.0
- [express-session](https://npm.io/package/express-session.md) ^1.17.2
- [node-stream-zip](https://npm.io/package/node-stream-zip.md) ^1.15.0
- [passport-ldapauth](https://npm.io/package/passport-ldapauth.md) ^3.0.1
- [passport-strategy](https://npm.io/package/passport-strategy.md) ^1.0.0
- [html-minifier-terser](https://npm.io/package/html-minifier-terser.md) ^6.0.2

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads
- [zulip-cloud9](https://npm.io/package/zulip-cloud9.md) — 3 weekly downloads

## Recent versions

- 8.2.0 (latest) — 2023-02-27
- 8.1.0 — 2022-04-15
- 8.0.4 — 2022-04-04
- 8.0.3 — 2022-03-10
- 8.0.2 — 2021-11-19
- 8.0.1 — 2021-11-19
- 8.0.0 — 2021-11-19
- 7.0.0 — 2020-05-04
- 6.2.2 — 2019-09-02
- 6.2.1 — 2019-06-04
- 6.2.0 — 2019-03-25
- 6.1.0 — 2018-10-26
- 6.0.0 — 2018-10-16
- 5.1.1 — 2018-05-30
- 5.1.0 — 2018-05-04
- … 17 more at https://npm.io/package/@openveo/api/versions

## README

# OpenVeo API

OpenVeo API is part of the [OpenVeo core](https://github.com/veo-labs/openveo-core), it aims to facilitate development of plugins.

OpenVeo API is not a plugin.

# Installation

No installation is required, OpenVeo API is part of [OpenVeo core](https://github.com/veo-labs/openveo-core).

# Usage

```javascript
var api = require('@openveo/api');
```

# API

Documentation is available on [Github pages](https://veo-labs.github.io/openveo-api/8.2.0/index.html).

# Contributors

Maintainer: [Veo-Labs](http://www.veo-labs.com/)

# License

[AGPL](http://www.gnu.org/licenses/agpl-3.0.en.html)

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