syncano-cli

Syncano CLI

You can find more information about Syncano_v5 in our Specification

Node version prerequisite

Not older than

Installation

# Locally
$ npm install
$ npm run build

# Globally
$ npm install -g

To run it

$ syncano-cli

  Usage: cli [options] [command]

  Commands:

    init [options]   init project
    socket           Manage sockets
    hosting          Manage hosting
    sync             synchronize configuration
    help [cmd]       display help for [cmd]

  Options:

    -h, --help  output usage information

Initialize an instance

# This will connect cli to your account and create a new instance
$ syncano-cli init

# This allows you to choose an existing instance
$ syncano-cli init --instance <existing_instance_name>

# Welcome screen, provide email and password to your syncano account
Welcome to Syncano (syncano.io)
Please login or create an account by entering your email and password:

Instance has been created

Creating Syncano Instance... Done
Setting up config files... Done

Add a Hosting

# For add new hosting to your project use:
$ syncano-cli hosting add

# You can also choose path to hosting directly:
$ syncano-cli hosting add [path_to_hosting_files]

If you don't specify path in command, you will be able to choose one from select list. This action allow only to add new hosting to your project. After that you should synchronize your local files with remote files on hosting.

List hostings

# To list your hosting containers type:
$ syncano-cli hosting list

Example response:

    Your hosting containers:

         name: hello
          url: https://hello--morning-wood-4770.syncano.site

List installed sockets

# To list your sockets type:
$ syncano-cli socket list

Example response:

         socket: test
    description: Test Socket

         endpoint: test/hello
      description: Hello world!
             path: https://morning-wood-4770.syncano.space/test/hello/

Full info about socket

# To list your sockets type:
$ syncano-cli socket info test

Example response:

         socket: hello
    description: Test Socket

         endpoint: test/hello
      description: Hello world!
             path: https://morning-wood-4770.syncano.space/test/hello/

                name: lastname
         description: Last name of the person you want to greet
             example: Durden

                name: firstname
         description: First name of the person you want to greet
             example: Tyler

            response: text/plain

         description: Success
            exit code: 200
             example: Hello Tyler Durden!

         description: Failed
           exit code: 400
             example: No first name or last name provided :(

Environment variables

During Continues Integration process it is easier to configure your project and access to your Syncano Instance using environment variables. Setting those variables you can override settings from ~/.syncano.yml file and default Syncano API hostname:

CLI is checking those variables:

• SYNCANO_HOST - API host (usually api.syncano.io)
• SYNCANO_PROJECT_INSTANCE - Syncano instance for a project
• SYNCANO_AUTH_KEY - Account API Key (you can find it in dashboard or by logging in using API)

Tests

CLI is provided with Unit tests in Mocha.

To run them:

npm run unit

To watch for changes:

npm run unit:watch

To make sure you have your environment ready

npm run validate