eko-cli

eko-cli

A command line tool for developers interacting with Eko Studio projects.

Quick start

First, you will need to sign up at Eko Studio.

Install the CLI globally by using npm install -g eko-cli.

Usage

Usage is automatically generated; to get usage for a particular subcommand, type the help subcommand at the end of the namespace or subcommand, e.g. eko-cli studio help.

Project Development

Log in in with your studio user account by running eko-cli user login.

To add code to an existing Eko Studio project, use the checkout command.

Run eko-cli studio checkout -p [PROJECT_ID].

A directory with the name PROJECT_ID will be created. It contains the Eko Studio project's code and it is also a git repository, connected to the project. You can now use any git client to add and update the code to this project. If there any changes made and pushed in Eko Studio, git pull will allow you to get them.

To test a local version of your project, run eko-cli studio test. (Notice you need to click the mixed content warning in chrome and choose “Load unsafe scripts”)

Keytar and Storing Credentials

For storing encrypted credentials with the OS, keytar must be installed & compiled before use (its OS bindings mean it needs more love than most npm packages). To allow use without keytar, our package.json lists it as a peer dependency, and there is a filesystem-based fallback if keytar is not available.