synchro2.3.2 • Public • Published
synchro -- Synchro Command Line Interface
synchro is a command-line tool for installing and managing your Synchro Node servers and applications.
Synchro Quick Start
npm install synchro -g
--help command to get basic comand help:
After installing the command line interface, you need to authenticate to the Synchro server so that you can download the required packages. Go to synchro.io/signup to create an account. Then run:
When prompted, supply the email address and password that you used to set up your account on the Synchro.io web site. You will only have to do this once per machine.
Creating a Synchro server on your machine
After authenticating, create a new directory and switch to it, then run:
This will install the Synchro server application and use npm to install all required packages.
Creating your first Synchro App
Once Synchro has been initialized, you can create your first Synchro app by doing:
synchro new hello-world
Running the Synchro server
You can start the server to play with your new app by doing:
Or if you prefer:
Note: Use the -h option to get detailed help on an individual command. For example:
synchro new -h
Add an app whose container exists in the module store to the current configuration
Authenticate to the Synchro.io server using your Synchro.io username/password, so that you can then download and install the Synchro server using
Remove the app from the current config (if installed there) and remove the container from the module store (whethere or not the app was installed in the current config).
Download, install, and configure a Synchro server in the current working directory.
Retreive a remote Synchro application and install it in the current configuration and module store.
List installed apps.
Create a new application in the module store and add it to the current configuration.
Remove an app from the current config without removing its container from the module store.
Ensure that the dependencies of a specified Synchro app are installed on the local server. Not implemented yet!
Update a Synchro server in the current working directory to the most current version.
Sets/clears a username/password combination in the current configuration, where such username/password is used by the default Synchro Studio auth. Username and hash of password are written under STUDIO_USERS in current config.