Build-cli NPM | npm.io

build-cli 0.3.5

build-cli allows you to manage your Electric Imp development from a command line through Electric Imp’s Build API.

Installation

build-cli requires node and npm — see Nodejs.org for installation instructions. With node and npm installed enter the following:

npm install -g build-cli

Usage

After installation, the imp program will be available from your command prompt. From there you should be able to use all of the tools (which are self documented as shown below).

imp [command] [options]

Commands:

    devices     List and manage devices
    log         Display logs from the specified device
    migrate     Migrates a model from one account to another
    models      List and manage models
    new         Create an new, empty imp project, or reinitialize an existing one
    pull        Fetch latest build from the server
    push        Update the build, and push code to developer devices
    setup       Sets your global Build API key
    help        Display help for [cmd]

Options:

    -h, help     output usage information
    -V, version  output the version number

Introduction

In your home directory, run imp setup to set up your development environment. You will need a Build API key, which you can obtain by logging in to the Electric Imp IDE with your account credentials, and selecting ‘Build API Keys’ from the ‘username‘ menu on the top far right of the workspace.

Now you can create individual directories for each of your imp-based projects. To prepare a directory for use, change to the relevant directory and run imp new. You’ll be asked for a Build API key — just hit Enter to use the default value, the one you entered during the setup phase. Each project stores its own Build API key in addition to the global value stored during the setup process. This allows you to work on projects for other users, by entering a Build API key associated with their account when you run imp new, while also working on other projects of your own.

You will next be prompted for the name of the project. This can match an existing imp application (‘model’) or be entirely new if you want to create a project from scratch. You will also be asked to provide filenames — just hit Enter to use the default values — for your agent and device code files. These will be populated with the latest build from the Electric Imp impCloud™ if your project is derived from an existing model.

For further information, including a more detailed guide to using build-cli, please see the Electric Imp Dev Center.

Release History

0.3.5

Retry logging after error

0.3.4

Fix malformed dates in imp logs (thanks to @wcoole)

0.3.3

Add spinning indicator to provide user with activity feedback during long server access calls.
Improved table colouring.

0.3.2

log bug fix

0.3.1

log now has -l, --list option to retrieve a device's log entries in bulk (up to 200 entries)
new now allows you to specify a new model name using -t, --title
devices now allows you to specify a model name or ID using -m, --model
models now allows you to view the model a device is assigned to using -d, --device
General textual improvements
Support for build-api 0.3.1
Minor code changes

0.3.0

init command renamed new
login command renamed setup
Improved feedback messaging
log now has -t, --title option to log devices by name rather than device ID (-d, --device)
devices now has -c, --current option to list the devices assigned to the current project
Support for build-api 0.3.0

0.2.4

Initial release of Electric Imp fork of imp-cli, build-cli.

License

build-cli is licensed under the MIT License.

build-cli is based on imp-cli and imp-api by Cat Haines. imp-cli and imp-api are copyright © Cat Haines, 2015. build-cli is copyright © Cat Haines, 2015 and copyright © Electrc Imp Inc., 2015-16.