bruce-api-cli
v1.1.2
Published
Basic wrapper around `bruce-models` to interact with the Nextspace API through CLI.
Downloads
15
Readme
Bruce API CLI
Basic wrapper around bruce-models
to interact with the Nextspace API through CLI.
To get started install the library on your device:
npm i bruce-api-cli -g
Then login using:
nextspace login -u username -p password -a account
If you plan to communicate with different Nextspace accounts then login without specifying the account.
However you will need to specify the account during specific calls, eg: nextspace entity -id example -a account
.
Some example calls:
nextspace test -a example
To ping an account and test it is responsive.
nextspace entity -id example
To get an Entity record.
nextspace entity-type -id example
To get an Entity Type record.
nextspace reindex
To reindex an account. Specify an Entity Type with -typeId example
to reindex just one type.
nextspace account -id example
To get an account record.
nextspace account-limits -id example
To get an account's limit settings.
Requirements
You must have at least node v20 as the FormData class is not available in older versions.