# vingle-corgi-cli

> Restful HTTP Framework for AWS Lambda - AWS API Gateway Proxy Integration, CLI

Latest version **1.1.1** (published 2020-04-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install vingle-corgi-cli
pnpm add vingle-corgi-cli
yarn add vingle-corgi-cli
bun add vingle-corgi-cli
```

Provides the command `vingle-corgi`.

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2020-04-02 |
| First published | 2019-10-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^10.16.0 |
| Dependencies | 3 |
| Unpacked size | 9.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 52 |
| Author | Kurt Lee |
| Maintainers | kurtlee |

## Links

- npm: https://www.npmjs.com/package/vingle-corgi-cli
- Repository: https://github.com/balmbees/corgi
- Homepage: https://github.com/balmbees/corgi#readme
- Issues: https://github.com/balmbees/corgi/issues
- npm.io page: https://npm.io/package/vingle-corgi-cli

## Dependencies (3)

- [express](https://npm.io/package/express.md) ^4.17.1
- [commander](https://npm.io/package/commander.md) ^3.0.2
- [ts-json-schema-generator](https://npm.io/package/ts-json-schema-generator.md) ^0.58.1

## Recent versions

- 1.1.1 (latest) — 2020-04-02
- 1.1.0 — 2020-01-07
- 1.0.2 — 2019-10-23
- 1.0.1 — 2019-10-23
- 1.0.0-beta.3 — 2019-10-17
- 1.0.0-beta.2 — 2019-10-14
- 1.0.0-beta.0 — 2019-10-14

## README

# vingle-corgi-cli
CLI commands for development for vingle-corgi

## install 
```
npm install vingle-corgi-cli --save-dev
```

## vingle-corgi build <entitiesFolder>
read list of entities from given folder, generate definitions.json that contains JSONSchema of given entities
```
- src
  - api 
    - entities
      - post.ts
      - comment.ts
      - like.ts
```
*vingle-corgi build "./src/api/entities/"*

## vingle-corgi run-local <apiHandlerPath>
run corgi webserver locally, through express wrapper.
apiHandlerPath should be js file that has export of corgi handler,
```
# ./src/api/index.js
import * as _ from "lodash";
import { Namespace, OpenAPIRoute, Router } from "vingle-corgi";

import { routes } from "./routes";

import * as entityDefinitions from "./entities/definitions.json";

export const router = new Router([
  new OpenAPIRoute(
    "/open-api",
    {
      title: "ExchangeService",
      version: "1.0.0",
      definitions: entityDefinitions,
    },
    routes,
  ),
  new Namespace("", {
    children: routes,
  }),
]);

export const handler = router.handler();
```

*vingle-corgi run-local "./src/api/index.js"*

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