Kinvey CLI Download

Version 6.1.3 - Mar 5, 2021
We recommend using NPM to install the latest library.

To install the latest stable version:

npm install -g kinvey-cli

To install the latest beta version:

npm install -g kinvey-cli@next


Want to see how the rest of your backend is evolving? Check out the timeline.

- Mar 5, 2021

  • Improve error message for iOS push settings in config management

- Feb 16, 2021

  • Modify collection hooks sequentially
  • Add collection hooks: onPreInsert, onPreUpdate, onPostInsert, onPostUpdate

- Oct 30, 2020

  • Do not update the appEnv when no settings are supplied on kinvey appenv apply
  • Fix appEnv ID check

- Sep 14, 2020

  • Support login with external identity providers

- Jul 2, 2020

  • Modify commands to accept only --org <org> (--app <app> is no longer valid):
    • flex init
    • flex create
    • flex list
    • service create
    • website create
    • app create
  • Remove flex job command
  • Update API version to 4
  • Update min node version to 12.16.1

- Nov 28, 2019

  • Add config management feature
  • Improve profile description
  • Improve response error handling

- Sep 19, 2019

  • Validate files size when deploying websites

- Aug 1, 2019

  • Show an output error if an identifier (e.g. --app) matches more than one entity

- May 16, 2019

  • Improvements to the website deploy command:
    • Verify presence of index and/or error page
    • Ability to force the deploy using the --force flag
  • Add node12 (Node.js v.12) to flex commands that support Node.js runtime selection

- Apr 25, 2019

  • Support for Kinvey Web Hosting under the website command namespace

- Mar 20, 2019

  • The flex status command outputs statuses using upper case letters

- Mar 5, 2019

  • Suggest command when token is expired
  • Use backend error when HTTP status code is 401

- Nov 29, 2018

  • Bug fix: Preserve existing environment variables on flex deploy --set-vars <env variables>

- Nov 27, 2018

  • Support for service environments when working with Flex services

- Nov 21, 2018

  • Support for selecting a Node.js runtime version using --runtime

- Nov 8, 2018

  • The app create command now supports the --org option
  • Support for environment variables for internal Flex services
  • Help information for kinvey <namespace>
  • The development dependencies have been updated

- Aug 24, 2018

  • Rename the env namespace to appenv
  • Ability to specify an organization when creating an app

- Jul 20, 2018

  • Prompt for 2FA token on profile login if required
  • Log output columns have been rearranged to show timestamp, log ID, and then logged message
  • Output logs properly when the log message is an object

- Jul 20, 2018

  • Prompt for 2FA token on profile login if required
  • Log output columns have been rearranged to show timestamp, log ID, and then logged message
  • Output logs properly when the log message is an object

- May 28, 2018

  • Ability to create internal Flex services using flex create.
  • Ability to delete internal Flex services using flex delete. Note that this command name was used to clear Node.js project setting in previous versions.
  • The flex delete command available in previous versions has a new name: flex clear. It keeps its behavior.
  • All delete commands now require confirmation that you can avoid using the new --no-prompt flag (available only for delete commands).
  • Unknown hyphenated options or flags now cause the command to exit with an error instead of being ignored.
  • Dependency updates: moment.js, request.js.

- Apr 25, 2018

  • Support for managing apps within your Kinvey account: creating, listing, viewing details, deleting, and setting as active.
  • Support for managing environments within your Kinvey account: creating, listing, viewing details, deleting, and setting as active.
  • Support for managing collection within a Kinvey app: creating, listing, and deleting.
  • Ability to view organizations and set an organization as active.
  • The profile login command updates the token only.

- Apr 13, 2018

  • Support for 2-factor authentication. See the --2fa global option.
  • New command for reauthenticating the specified profile: kinvey profile login.
  • Ask for profile override if profile already exists on kinvey init.
  • Use active profile if no other specified on kinvey profile delete.

Open the Kinvey CLI GitHub repo for full documentation and source code.

- Feb 27, 2018

  • Support for entering Instance ID instead of instance URL for dedicated client instances
  • More detailed and useful error messages
  • The flex deploy command now accepts --serviceId
  • The flex init command now requires a profile and ignores the --email, --password, and --host options
  • Support for outputting in JSON format
  • New --no-color flag for disabling colors in output
  • Bug fixes

Open the Kinvey CLI GitHub repo for full documentation and source code.

- Jan 4, 2018

Install the latest beta using npm install -g kinvey-cli@next.

  • Support for using multiple Kinvey accounts through profiles
  • All Flex-related commands move under the flex namespace (e.g. status becomes flex status)
  • New commands:
    • init—Initializes Kinvey CLI by prompting for credentials and configurations options
    • flex init—Configures Kinvey CLI to work with a specific Flex Service
  • All commands (except for init) can now take credentials as command-line options or ENV variables
  • Removed commands:
    • config
    • logout
  • New command-line options specific to commands under the flex namespace
  • The request timeout has been increased to 10 s

- Oct 26, 2017

  • status command now reports the email address (plus first/last name, if set) of deployer and the date/time at which service was deployed

- Oct 4, 2017

  • status command now reports the version of the most recently-deployed service
  • logs command enhancements
    • [from] and [to] optional arguments replaced with --from and --to flags
    • Added -n (--number) and --page flags
    • Only 100 entries are returned by default unless the -n flag is supplied

- Jul 25, 2017

  • Fixed bug resulting in 2FA login crash

- Jul 25, 2017

  • ES6 rewrite
  • Support 2FA token login
  • Add ability to login to the CLI using ENV variables

- Jun 20, 2017

  • Fixed bug where instance param was not respected when running config [instance] in a fresh environment

- May 5, 2017

  • Fixed crash on config against the default instance (under certain scenarios)

- Feb 25, 2017

  • Added HTTPS proxy usage information to README

- Jan 26, 2017

  • Fixed bug which resulted in a 'ProjectNotConfigured' error when running the list command with a successfully configured project

- Jan 12, 2017

  • Fixed bug which resulted in a CLI crash when parsing/printing non-string log message data
    • Skip log entries which have no corresponding message (and report which entries have been skipped when running CLI in verbose mode)

- Jan 9, 2017

  • CLI now supports operations against data links backed by Kinvey organizations
  • kinvey config targets the default Kinvey instance for data link selection if a host is not provided (even if the CLI was previously configured with a custom host)
  • Fixed 'Archive Limit Exceeded' bug occasionally encountered during deployment of valid Kinvey services from within Windows environments
  • Update CLI update check frequency (interval shortened to 30 minutes)
  • Fixed bug where 'ProjectNotConfigured' was not correctly displayed after attempting to execute commands without a valid CLI configuration

- Nov 15, 2016

  • Remove duplicate 'host' output during config command when using custom Kinvey instance

- Nov 15, 2016

  • Cache last recycle job ID
  • Update session storage filename

- Nov 10, 2016

  • Add support for refactored KBW/KMR 'status' command. Repurpose existing 'status' command into 'job'
  • Cache last deploy job for ease of retrieval using kinvey job
  • Add support for logging thresholds (requires Flex SDK >= 1.0.0)
  • Allow setting of persistent host via kinvey config [instance]
  • config command now prompts for a new service on every run (fixed prior bug where it did nothing if saved data was already present)
  • Upgrade CLI to check for kinvey-flex-sdk (instead of kinvey-backend-sdk)
  • logs command now takes optional runtime arguments (instead of prompting for log filters)
  • Obfuscate instance URLs at configuration time (e.g. kinvey config acme-us1)
  • Fixed bug where credentials were improperly cleared during logout/refresh
  • Fixed bug where status command (no arg command) crashed if supplied with an argument

- Aug 8, 2016

  • Support node 6.x

- Apr 21, 2016

  • Handle authentication errors when deploying.

- Mar 17, 2016

  • Do not display progress message for completed jobs.

- Mar 11, 2016

  • Display progress and error messages when retrieving deploy status.

- Feb 25, 2016

  • Implement logs command

- Jan 8, 2016

  • Refactor routes.

- Sep 25, 2015

  • Renew expired tokens.
  • Updated dependencies.

- Sep 21, 2015

  • Initial version.