Dynomate
Browse documentation

Install the Dynomate CLI

On this page5
  1. 1Requirements
  2. 2Install the CLI
  3. 3Compatibility with the desktop app
  4. 4Verify the installation
  5. 5Troubleshooting

The Dynomate CLI is a separate command-line client. Its command is dynomate-cli. The dynomate command is for the desktop app.

Requirements

  • One of these platforms:
    • macOS 11 or later, on Apple silicon or Intel
    • 64-bit GNU/Linux with glibc 2.35 or later
    • 64-bit Windows
  • Node.js 18 or later, with npm.
  • HTTPS access to the Dynomate release service during the installation.
  • AWS credentials from an AWS profile or environment variables.
  • Dynomate CLI 0.1.0 or later for Amazon Aurora DSQL operations. See Compatibility with the desktop app.
  • For Aurora DSQL, outbound TCP port 5432 to the cluster.

The CLI is free. It does not need a Dynomate account or license.

Install the CLI

To install the CLI, run this command:

Shell
npm install --global \ --ignore-scripts=false \ --allow-scripts=@dynomate/cli \ @dynomate/cli

The package install script downloads the native executable. The two script flags make sure that npm runs this script.

To upgrade the CLI, run the same command again.

Test releases go to the npm next tag first. To install a test release, add @next to the package name.

Compatibility with the desktop app

Aurora DSQL operations need Dynomate CLI 0.1.0 or later.

Update the CLI when you update the desktop app to Dynomate 2.1.0. Dynomate 2.1.0 updates the app database for Aurora DSQL. When Dynomate CLI 0.0.21 or earlier uses the same app data directory, each requests run fails with this error:

Text 
APP_DATA_SCHEMA_UNSUPPORTED: Database schema was created by a newer Dynomate version (unknown migrations: …). Upgrade dynomate-cli before using shared app data.
  • The error stops all requests, also requests with only DynamoDB or Athena operations.
  • An older CLI also rejects Aurora DSQL operations with DNML_UNSUPPORTED_OPERATION.

To update the CLI:

  1. Run the install command again.
  2. Show the version of the CLI:
    dynomate-cli --version

The version must be 0.1.0 or later.

Verify the installation

Run these commands:

Shell
dynomate-cli --version
dynomate-cli --help

The CLI shows its version and its help. If it shows that the native installation is incomplete, see The native installation is incomplete.

Next, run a request or use the CLI in CI.

Troubleshooting

The native installation is incomplete

This message shows that npm did not run the postinstall script of the package.

  1. Show your npm setting:
    npm config get ignore-scripts
  2. If the value is true, run the install command again. Do not remove --ignore-scripts=false.

The --ignore-scripts=false flag applies only to that command. The --allow-scripts flag alone does not change a saved ignore-scripts=true setting.

npm shows ENOVERSIONS

A local release-age policy can hide a new release.

  1. Show your npm setting:
    npm config get min-release-age
  2. To install the new release, add --min-release-age=0 to the install command.

The --min-release-age=0 flag applies only to that command.

npm does not recognize --allow-scripts

Older npm versions do not have this flag. Do one of these steps:

  • Upgrade npm.
  • Remove --allow-scripts=@dynomate/cli from the install command. Keep --ignore-scripts=false, because the native installer must run.

For errors when you run a request, see CLI error codes.