Table of Contents generated with DocToc

• boats-cli
  • Quick Start

boats-cli

boats-cli is the unofficial CLI for johndcarmichael/boats.

Early alhpa, docs and functionality will change

Quick Start

npx @acrontum/boats-cli --help
npx @acrontum/boats-cli path --help
npx @acrontum/boats-cli model --help

For an empty boats project:

mkdir backend-spec

cd backend-spec

npm init --yes

npx @acrontum/boats-cli \
  path auth/verify --get \
  path auth/login --post \
  path auth/logout --get \
  path auth/refresh-token --get \
  path albums/:albumId --post --get --patch --delete --list \
  path albums/:albumId/songs/:songId -crudl \
  model jwt \
  model search --type query

npm i -D boats
npx boats -i src/index.yml -o build/api.json

optionally, since it's long to type:

npm i -D @acrontum/boats-cli

then you can then just npx bc model test --dry-run.