Method: PI::Cli::Runner#command_usage

Defined in:
lib/cli/usage.rb

#command_usageObject



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/cli/usage.rb', line 20

def command_usage
  <<-USAGE

#{basic_usage}

Currently available pi commands are:

User
  login [url] [--user,--password]                             Login
  logout                                                      Logs current user out of the system
  info                                                        List system information
  user                                                        Display user information
  targets                                                     List available targets infomation
  password [oldpassword] [--password PASS]                    Change the password for the current user
  github [name] [--email,--password]                          Bind to the github account
  runtimes                                                    Display the supported runtimes of the system
  frameworks                                                  Display the supported frameworks of the system
  version                                                     Display version information
  help [command]                                              Get general help or help on a specific command
  help options                                                Get help on available options
  
Project
  projects                                                    List created projects 
  create-project [project]                                    Create a new project                
  delete-project [projectid]                                  Delete the project             
  project-events [projectid]                                  List the event info for the project
  project-tags [projectid]                                    List the tags for the project
  project-commits [projectid]                                 List the commit log for the project
  upload [projectid] [--path,--ver,--desc]                    Upload the war package for java project
  
Application 
  apps [--projectid,--target]                                 List deployed applications
  create-app [appname]                                        Create a new application
  delete-app [appid]                                          Delete the application
  delete-app <appname> <--target TARGET>                      Delete the application
  start-app [appid]                                           Start the application
  start-app <appname> <--target TARGET>                       Start the application
  stop-app [appid]                                            Stop the application
  stop-app <appname> <--target TARGET>                        Stop the application
  stop-app --graceful                                         Stop the application in a graceful mode
  restart-app [appid]                                         Restart the application
  restart-app <appname> <--target TARGET>                     Restart the application
  restart-app --graceful                                      Restart the application in a graceful mode
  scale-app [appid] [--instance N]                            Scale the application instances up or down
  scale-app <appname> <--target TARGET> [--instance N]        Scale the application instances up or down
  update-app [appid] [--ver VERSION]                          Update the application
  update-app <appname> <--target TARGET> [--ver VERSION]      Update the application
  update-app --graceful                                       Update the application in a graceful mode
  status [appid]                                              Display resource usage for the application
  status <appname> <--target TARGET>                          Display resource usage for the application
  app-env [appid]                                             Display the environments for the application
  app-env <appname> <--target TARGET>                         Display the environments for the application
  create-env [appid] [--name,--value]                         Create the environment for the application
  create-env <appname> <--target TARGET> [--name,--value]     Create the environment for the application
  delete-env [appid] [--name NAME]                            Delete the environment for the application
  delete-env <appname> <--target TARGET> [--name NAME]        Delete the environment for the application
  app-log [appid] [--instanceid,--file]                       List the logs for the application
  app-log <appname> <--target TARGET> [--instanceid,--file]   List the logs for the application
  
Service
  app-service [appid]                                         Display the binded services for the application
  app-service <appname> <--target TARGET>                     Display the binded services for the application
  bind-service [appid] [--service SERVICE]                    Bind the services for the application
  bind-service <appname> <--target TARGET> [--service]        Bind the services for the application
  unbind-service [appid] [--service SERVICE]                  Unbind the services for the application
  unbind-service <appname> <--target TARGET> [--service]      Unbind the services for the application
  services                                                    List dedicated services
  service [serviceid]                                         List the connection info for the service
  export-service [serviceid]                                  Export dedicated service url
  import-service [url]                                        Import dedicated service
  check-service [serviceid]                                   Check availability for the service 
  delete-service [serviceid]                                  Delete the service
  register-service [serviceid] [--target TARGET]              Register to target
  deregister-service [serviceid] [--target TARGET]            Deregister to target
  
DNS
  app-dns [appid]                                             Display the mapped urls for the application
  app-dns <appname> <--target TARGET>                         Display the mapped urls for the application
  map-dns [appid] [--dns DNS]                                 Map the urls for the application
  map-dns <appname> <--target TARGET> [--dns DNS]             Map the urls for the application
  unmap-dns [appid] [--dns DNS]                               Unmap the urls for the application                                      
  unmap-dns <appname> <--target TARGET> [--dns DNS]           Unmap the urls for the application
  dns                                                         List the dns
  zones                                                       List the dns zones
  dns-records [dnsid]                                         List the record info for the registered dns
  create-dns [dnsname] [--zoneid,--projectid,--desc]          Create a new dns
  register-dns [dnsid] [--target,--continent,--country]       Register to target
  deregister-dns [dnsid] [--recordid ID]                      Deregister to target
  delete-dns [dnsid]                                          Delete the dns
USAGE

end