# @elastictable/dynamodb-api > DynamoDB API generator Latest version **1.5.0** (published 2020-09-29) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install @elastictable/dynamodb-api pnpm add @elastictable/dynamodb-api yarn add @elastictable/dynamodb-api bun add @elastictable/dynamodb-api ``` Provides the command `dynamodb-api`. ## 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.5.0 | | Published | 2020-09-29 | | First published | 2020-08-21 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | bundled | | Module format | CommonJS | | Node | >=12.0.0 | | Dependencies | 11 | | Unpacked size | 467.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Elastictable Team | | Maintainers | stephankaag | | Keywords | oclif | ## Links - npm: https://www.npmjs.com/package/@elastictable/dynamodb-api - Repository: https://github.com/elastictable/dynamodb-api - Issues: https://github.com/elastictable/dynamodb-api/issues - npm.io page: https://npm.io/package/@elastictable/dynamodb-api ## Dependencies (11) - [cli-ux](https://npm.io/package/cli-ux.md) ^5.4.9 - [graphql](https://npm.io/package/graphql.md) ^15.3.0 - [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.16.0 - [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.7.0 - [load-json-file](https://npm.io/package/load-json-file.md) ^6.2.0 - [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^3.1.0 - [@oclif/plugin-update](https://npm.io/package/@oclif/plugin-update.md) ^1.3.10 - [@elastictable/schemas](https://npm.io/package/@elastictable/schemas.md) ^1.10.7 - [@oclif/plugin-not-found](https://npm.io/package/@oclif/plugin-not-found.md) ^1.2.4 - [@oclif/plugin-autocomplete](https://npm.io/package/@oclif/plugin-autocomplete.md) ^0.2.0 - [@oclif/plugin-warn-if-update-available](https://npm.io/package/@oclif/plugin-warn-if-update-available.md) ^1.7.0 ## Alternatives - [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads - [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads - [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads - [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads - [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads ## Recent versions - 1.5.0 (latest) — 2020-09-29 - 1.4.2 — 2020-09-28 - 1.4.1 — 2020-09-09 - 1.4.0 — 2020-08-25 - 1.3.0 — 2020-08-21 ## README # DynamoDB API generator [DynamoDB-API](https://dynamodb-api-generator.elastictable.com), an open-source NodeJS CLI-tool for developing GraphQL APIs instantly on top of AWS's [DynamoDB](https://aws.amazon.com/dynamodb) and [AppSync](https://aws.amazon.com/appsync/). It aims to simplify the effort required to model GraphQL APIs with a single-table design. [![GitHub license](https://img.shields.io/github/license/elastictable/dynamodb-api)](https://github.com/elastictable/dynamodb-api/blob/master/LICENSE) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) ![Node.js CI](https://github.com/elastictable/dynamodb-api/workflows/Node.js%20CI/badge.svg) ------- ## About This project combines the various articles, best practices and tutorials written about DynamoDB's single-table design and automates the modeling process in a user-friendly tool. ## Installation Install or update [DynamoDB API] from npm (requires [Node.js ≥ 10.13.0](https://nodejs.org/download/release/latest-v10.x/)). Only [Active LTS](https://nodejs.org/en/about/releases/) Node versions are supported. ```bash $ npm i -g @elastictable/dynamodb-api ``` * [DynamoDB API generator](#dynamodb-api-generator) * [Usage](#usage) * [Commands](#commands) # Usage ```sh-session $ npm install -g @elastictable/dynamodb-api $ dynamodb-api COMMAND running command... $ dynamodb-api (-v|--version|version) @elastictable/dynamodb-api/1.5.0 linux-x64 node-v12.18.4 $ dynamodb-api --help [COMMAND] USAGE $ dynamodb-api COMMAND ... ``` # Commands * [`dynamodb-api autocomplete [SHELL]`](#dynamodb-api-autocomplete-shell) * [`dynamodb-api help [COMMAND]`](#dynamodb-api-help-command) * [`dynamodb-api update [CHANNEL]`](#dynamodb-api-update-channel) ## `dynamodb-api autocomplete [SHELL]` display autocomplete installation instructions ``` USAGE $ dynamodb-api autocomplete [SHELL] ARGUMENTS SHELL shell type OPTIONS -r, --refresh-cache Refresh cache (ignores displaying instructions) EXAMPLES $ dynamodb-api autocomplete $ dynamodb-api autocomplete bash $ dynamodb-api autocomplete zsh $ dynamodb-api autocomplete --refresh-cache ``` _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v0.2.0/src/commands/autocomplete/index.ts)_ ## `dynamodb-api help [COMMAND]` display help for dynamodb-api ``` USAGE $ dynamodb-api help [COMMAND] ARGUMENTS COMMAND command to show help for OPTIONS --all see all commands in CLI ``` _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_ ## `dynamodb-api update [CHANNEL]` update the dynamodb-api CLI ``` USAGE $ dynamodb-api update [CHANNEL] ``` _See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v1.3.10/src/commands/update.ts)_ --- _Source: https://npm.io/package/@elastictable/dynamodb-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._