| 1 | # Kinvey CLI
|
| 2 | > Utility for deploying and managing FlexServices on Kinvey's FlexService Runtime
|
| 3 |
|
| 4 | ## Installation
|
| 5 | `npm install -g kinvey-cli`
|
| 6 |
|
| 7 | ## Usage
|
| 8 | In your project directory, run `kinvey config` to set-up your project. The CLI will prompt for Kinvey credentials, app, and Internal Flex Service.
|
| 9 |
|
| 10 | ### Commands
|
| 11 | * `config [instance]` - set project options (including optional dedicated Kinvey instance name)
|
| 12 | * `deploy` - deploy the current project as an Internal Flex Service. You can check the status of a deploy using the `job` command (more info below).
|
| 13 | * `status` - display the health status of an Internal Flex Service
|
| 14 | * `help` - display usage information.
|
| 15 | * `list` - list the configured Internal Flex Services for the current app.
|
| 16 | * `logs [from] [to]` - query logs for this Internal Flex Service
|
| 17 | * 'from' and 'to' arguments represent optional ISO-8601 timestamp strings
|
| 18 | * **Note:** Logs calls are limited to 10,000 entries
|
| 19 | * Logs are displayed in the following format: `<runtime id> <timestamp> - <message>`
|
| 20 | * E.g. `ac7df839104d 2016-02-23T20:00:29.334Z - hello world`
|
| 21 | * `logout` - clears Kinvey session data and project settings
|
| 22 | * `job <id>` - return the status of a `deploy` command.
|
| 23 |
|
| 24 | ### Options
|
| 25 | * `-e, --email <e-mail>` - e-mail address of your Kinvey account.
|
| 26 | * `--host <host>` - set host of the Kinvey service.
|
| 27 | * `-p, --password <password>` - password of your Kinvey account.
|
| 28 | * `-s, --silent` - do not output anything.
|
| 29 | * `-c, --suppress-version-check` - do not check for package updates.
|
| 30 | * `-v, --verbose` - output debug messages.
|
| 31 |
|
| 32 | The Kinvey CLI supports one-time session creation using the `-e` and `-p` (and optionally `--host`) flags. Set these parameters explicitly in your calls if you are unable to init with `kinvey config`.
|
| 33 |
|
| 34 | ## Troubleshooting
|
| 35 | Run any command with the `-v` (`--verbose`) flag to see what is going on when executing a command. If problems persist, please contact [Kinvey](http://support.kinvey.com). In any case, make sure you have configured your project using the `config` command before attempting to execute any other commands.
|
| 36 |
|
| 37 | ## Changelog
|
| 38 | See the [Changelog](./CHANGELOG.md) for a list of changes.
|
| 39 |
|
| 40 | ## License
|
| 41 | Copyright (c) 2016, Kinvey, Inc. All rights reserved.
|
| 42 |
|
| 43 | This software is licensed to you under the Kinvey terms of service located at
|
| 44 | http://www.kinvey.com/terms-of-use. By downloading, accessing and/or using this
|
| 45 | software, you hereby accept such terms of service (and any agreement referenced
|
| 46 | therein) and agree that you have read, understand and agree to be bound by such
|
| 47 | terms of service and are of legal age to agree to such terms with Kinvey.
|
| 48 |
|
| 49 | This software contains valuable confidential and proprietary information of
|
| 50 | KINVEY, INC and is subject to applicable licensing agreements.
|
| 51 | Unauthorized reproduction, transmission or distribution of this file and its
|
| 52 | contents is a violation of applicable laws. |
| \ | No newline at end of file |