Install & Usage

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
1
synpse devices
Copied!
List deployed applications
1
synpse ps
Copied!
SSH into device
1
synpse ssh <device name>
Copied!
Viewing all available commands
synpse --help will give you root commands available for you:
1
$ synpse --help
2
Client utility for Synpse.net. Version: 0.7.14
3
​
4
Usage:
5
  synpse [command]
6
​
7
Available Commands:
8
  application    Manage applications
9
  config         Configure cli
10
  deploy         Deploy and application
11
  device         Manage devices
12
  help           Help about any command
13
  member         Manage memberships
14
  namespace      Manage namespaces
15
  project        Manage projects
16
  ps             list applications
17
  role           Manage roles
18
  secret         Manage secrets
19
  serviceaccount Manage service accounts
20
  ssh            SSH into a device
21
  update-cli     OTA update for CLI
22
  version        CLI version
23
​
24
Flags:
25
  -h, --help              help for synpse
26
  -l, --loglevel string   Valid values are [debug, info, warning, error] (default "info")
27
  -o, --output string     Valid values are [table, json, yaml] (default "table")
28
  -w, --work-dir string   Working directory for CLI (default "/home/mjudeiki/.synpse")
29
​
30
Use "synpse [command] --help" for more information about a command.
Copied!
Same individual commands will give the same for the sub-command: synpse applications --help
1
synpse applications --help
2
Manage synpse applications and their lifecycle
3
​
4
Usage:
5
  synpse application [flags]
6
  synpse application [command]
7
​
8
Aliases:
9
  application, applications
10
​
11
Available Commands:
12
  create      Create ad application
13
  delete      Delete an application
14
  edit        Edit an application
15
  inspect     Inspect an application
16
  list        List applications
17
  logs        Applications logs
18
​
19
Flags:
20
  -h, --help   help for application
21
​
22
Global Flags:
23
  -l, --loglevel string   Valid values are [debug, info, warning, error] (default "info")
24
  -o, --output string     Valid values are [table, json, yaml] (default "table")
25
  -w, --work-dir string   Working directory for CLI (default "/home/mjudeiki/.synpse")
26
​
27
Use "synpse application [command] --help" for more information about a command.
Copied!

Agent - Previous

Uninstall

Next - synpse core

Devices

Last modified 10mo ago

Copy link

Contents

Install

Usage

Viewing all available commands