Install & Usage
Command Line Interface (CLI) is extended way to interact with Synpse Cloud

Install

To install CLI for multiple platform login into cloud.synpse.net and use CLI button in the right top corner. Copy provided command and execute on your system to install synpse CLI.

Usage

There are several shortcuts to help with day-to-day activities.

List your devices

synpse devices

List deployed applications

synpse ps

SSH into device

synpse ssh <device name>

Viewing all available commands

synpse --help will give you root commands available for you:
$ synpse --help
Client utility for Synpse.net. Version: 0.7.14
​
Usage:
synpse [command]
​
Available Commands:
application Manage applications
config Configure cli
deploy Deploy and application
device Manage devices
help Help about any command
member Manage memberships
namespace Manage namespaces
project Manage projects
ps list applications
role Manage roles
secret Manage secrets
serviceaccount Manage service accounts
ssh SSH into a device
update-cli OTA update for CLI
version CLI version
​
Flags:
-h, --help help for synpse
-l, --loglevel string Valid values are [debug, info, warning, error] (default "info")
-o, --output string Valid values are [table, json, yaml] (default "table")
-w, --work-dir string Working directory for CLI (default "/home/mjudeiki/.synpse")
​
Use "synpse [command] --help" for more information about a command.
Same individual commands will give the same for the sub-command: synpse applications --help
synpse applications --help
Manage synpse applications and their lifecycle
​
Usage:
synpse application [flags]
synpse application [command]
​
Aliases:
application, applications
​
Available Commands:
create Create ad application
delete Delete an application
edit Edit an application
inspect Inspect an application
list List applications
logs Applications logs
​
Flags:
-h, --help help for application
​
Global Flags:
-l, --loglevel string Valid values are [debug, info, warning, error] (default "info")
-o, --output string Valid values are [table, json, yaml] (default "table")
-w, --work-dir string Working directory for CLI (default "/home/mjudeiki/.synpse")
​
Use "synpse application [command] --help" for more information about a command.
Copy link
On this page
Install
Usage
Viewing all available commands