BINARYOPS CLI

This is the official command line tool for BinaryOps.io. Use it to manage your BinaryOps.io APIs.

This tool is currently pre-release with alpha version. We will release a beta version soon.

Installing

To install the Binaryops CLI, simply npm install it globally.

$ npm install -g binaryops

Usage

Using the CLI is easy. This is the usage info we are intending to implement in the first beta release.

Usage: binaryops [options] [command]

Commands:

init Prompt for username and CLI token

Options:

-h, --help output usage information

-V, --version output the version number

-f, --filename [filename] the API definition file to be uploaded.

-a, --apicode [apicode] the API Code for the definition file to be uploaded.

-r, --runlocal [runlocal] the runlocal config file to be used for local execution of the server code.

-d, --debugbrk [debugbrk] Run the server code locally using the debug-brk flag on the node process.

Examples:

$ binaryops init

$ binaryops -f myApi.json -a abc123

$ binaryops --filename myApi.json --apicode abc123

To run a serverside function locally:

$ binaryops --runlocal localConfig.json

To debug a serverside function locally:

$ binaryops --runlocal localConfig.json --debugbrk

sample content for a localConfig.json:

{
	"api_code"    :"abs123",
	"tenant_code" : "tnt456",
	"functionFile"    : "<relative_path><serveside_function-file>.js",
	"args"        : {<your JSON object to be passed in to the function}");
}

Account Setup

To start, you may need an account. Visit BinaryOps.io and follow the links to signup for an account. All you need is a valid email address. When you are logged in, navigate to the User Profile page and obtain your cli token. You need the token for the init command.

$ binaryops init

Documentation

Please go to the BinaryOps.io documentation for the complete and up to date reference material.

License

Copyright (c) BinaryOps Software Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.