sem 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91c9bf14f0ac746a36cb741716bdaf85a249208f
-  data.tar.gz: 60f37117fcf17aa6a6217fec94db649128a5c39a
+  metadata.gz: 5c1a10ab040f112a1f24a09ea5f73861b9071b43
+  data.tar.gz: ada5cba1c12170b169bee90ab53c91a450d61147
 SHA512:
-  metadata.gz: cc4436a876f21cee6646a046c768850113916e59436a1482a13e9ae50aa8586ea6d5944c32664d3a3d2108fa74aafacb80866d303e050bf16ce5b1a5cbe0be08
-  data.tar.gz: 4b98bc488569ed7359aa4ee82137c8ecc35d1150599495ecb1d412824231a18fb4ea594e851b4f92810a3a09a45533bc58a97e3ca6e74d1178660522222f8bbd
+  metadata.gz: 51a35aa698536afebe6c0308fb9ce7fef042ac215e9e69368e08d621732fce09cf53ac3ef1d7c8a322eaaac1ba4c969e3a6e589a37c27933057622b8e70353c2
+  data.tar.gz: 95db9b01b1c029800a19572d192322d46f9d2d9e77d0fe93ab4e22c42c279cca5749b0e1debc2f0c5ea816b7f0216072b961f5fb0f95289314e07a220a52366d

data/README.md

@@ -60,6 +60,16 @@ the [CLI development guide](guides.md).
 
 To run the CLI locally, use the `bundle exec sem`.
 
+#### Generating Docs
+
+First, generate a JSON structure of the CLI, by running:
+
+``` bash
+./bin/generate_json_structure
+```
+
+Use that structure to generate docs in the semaphore-docs-new repository.
+
 #### Semaphore Resource Name (SRN)
 
 SRN is a way of identifying Semaphore resources. This CLI uses SRNs as arguments

data/bin/generate_json_structure

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sem"
+
+puts Sem::CLI.structure.to_json

data/lib/sem/cli/orgs.rb

@@ -1,6 +1,14 @@
 class Sem::CLI::Orgs < Dracula
 
-  desc "list", "list organizations"
+  desc "list", "List all organizations"
+  long_desc <<-DESC
+Examples:
+
+    $ sem orgs:list
+    ID                                    NAME
+    5bc7ed43-ac8a-487e-b488-c38bc757a034  renderedtext
+    99c7ed43-ac8a-487e-b488-c38bc757a034  z-fighters
+DESC
   def list
     orgs = Sem::API::Org.all
 
@@ -12,6 +20,15 @@ class Sem::CLI::Orgs < Dracula
   end
 
   desc "info", "shows detailed information about an organization"
+  long_desc <<-DESC
+Examples:
+
+    $ sem orgs:info renderedtext
+    ID       5bc7ed43-ac8a-487e-b488-c38bc757a034
+    Name     renderedtext
+    Created  2017-08-01 13:14:40 +0200
+    Updated  2017-08-02 13:14:40 +0200
+DESC
   def info(org_name)
     org = Sem::API::Org.find!(org_name)
 
@@ -19,6 +36,15 @@ class Sem::CLI::Orgs < Dracula
   end
 
   desc "members", "list members of an organization"
+  long_desc <<-DESC
+Examples:
+
+    $ sem orgs:members renderedtext
+    NAME
+    darko
+    shiroyasha
+    bmarkons
+DESC
   def members(org_name)
     org = Sem::API::Org.find!(org_name)
 

data/lib/sem/cli/projects.rb

@@ -1,6 +1,15 @@
 class Sem::CLI::Projects < Dracula
 
-  desc "list", "list projects"
+  desc "list", "list all your projects"
+  long_desc <<-DESC
+Examples:
+
+    $ sem projects:list
+    NAME
+    ID                                    NAME
+    99c7ed43-ac8a-487e-b488-c38bc757a034  rt/cli
+    99c7ed43-ac8a-487e-b488-c38bc757a034  rt/api
+DESC
   def list
     projects = Sem::API::Project.all
 
@@ -12,6 +21,15 @@ class Sem::CLI::Projects < Dracula
   end
 
   desc "info", "shows detailed information about a project"
+  long_desc <<-DESC
+Examples:
+
+    $ sem projects:info renderedtext/cli
+    ID       99c7ed43-ac8a-487e-b488-c38bc757a034
+    Name     renderedtext/cli
+    Created  2017-08-01 13:14:40 +0200
+    Updated  2017-08-02 13:14:40 +0200
+DESC
   def info(project_name)
     project = Sem::API::Project.find!(project_name)
 
@@ -19,7 +37,28 @@ class Sem::CLI::Projects < Dracula
   end
 
   desc "create", "create a project"
-  option :url, :aliases => "-u", :desc => "Git url to the repository"
+  option :url, :aliases => "-u", :desc => "Git url to the repository", :required => true
+  long_desc <<-DESC
+Examples:
+
+    $ sem projects:create renderedtext/cli --url git@github.com:renderedtext/cli.git
+    ID       99c7ed43-ac8a-487e-b488-c38bc757a034
+    Name     renderedtext/cli
+    Created  2017-08-01 13:14:40 +0200
+    Updated  2017-08-02 13:14:40 +0200
+
+    $ sem projects:create renderedtext/api --url https://github.com/renderedtext/api
+    ID       99c7ed43-ac8a-487e-b488-c38bc757a034
+    Name     renderedtext/api
+    Created  2017-08-01 13:14:40 +0200
+    Updated  2017-08-02 13:14:40 +0200
+
+    $ sem projects:create renderedtext/api-tests --url https://github.com/renderedtext/api
+    ID       99c7ed43-ac8a-487e-b488-c38bc757a034
+    Name     renderedtext/api-tests
+    Created  2017-08-01 13:14:40 +0200
+    Updated  2017-08-02 13:14:40 +0200
+DESC
   def create(project_name)
     url = Sem::Helpers::GitUrl.new(options[:url])
 
@@ -38,7 +77,15 @@ class Sem::CLI::Projects < Dracula
 
   class Files < Dracula
 
-    desc "list", "list configuration files on project"
+    desc "list", "list configuration files for a project"
+    long_desc <<-DESC
+Examples:
+
+    $ sem projects:files:list renderedtext/cli
+    ID                                    PATH              ENCRYPTED?
+    77c7ed43-ac8a-487e-b488-c38bc757a034  /etc/a            true
+    11c7ed43-bc8a-a87e-ba88-a38ba757a034  /var/secrets.txt  true
+DESC
     def list(project_name)
       project = Sem::API::Project.find!(project_name)
 
@@ -50,6 +97,14 @@ class Sem::CLI::Projects < Dracula
   class EnvVars < Dracula
 
     desc "list", "list environment variables on project"
+    long_desc <<-DESC
+Examples:
+
+    $ sem projects:env-vars:list renderedtext/cli
+    ID                                    NAME    ENCRYPTED?  CONTENT
+    9997ed43-ac8a-487e-b488-c38bc757a034  SECRET  false       aaa
+    1117ed43-tc8a-387e-6488-838bc757a034  TOKEN   true        *encrypted*
+DESC
     def list(project_name)
       project = Sem::API::Project.find!(project_name)
 
@@ -61,6 +116,14 @@ class Sem::CLI::Projects < Dracula
   class SharedConfigs < Dracula
 
     desc "list", "list shared configurations on a project"
+    long_desc <<-DESC
+Examples:
+
+    $ sem projects:shared-configs:list renderedtext/cli
+    ID                                    NAME                 CONFIG FILES  ENV VARS
+    99c7ed43-ac8a-487e-b488-c38bc757a034  renderedtext/tokens             1         0
+    99c7ed43-ac8a-487e-b488-c38bc757a034  renderedtext/secrets            0         1
+DESC
     def list(project_name)
       project = Sem::API::Project.find!(project_name)
       shared_configs = project.shared_configs
@@ -73,6 +136,12 @@ class Sem::CLI::Projects < Dracula
     end
 
     desc "add", "attach a shared configuration to a project"
+    long_desc <<-DESC
+Examples:
+
+    $ sem projects:shared-configs:add renderedtext/cli renderedtext/secrets
+    Shared Configuration renderedtext/secrets added to the project.
+DESC
     def add(project_name, shared_config_name)
       project = Sem::API::Project.find!(project_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)
@@ -86,6 +155,12 @@ class Sem::CLI::Projects < Dracula
     end
 
     desc "remove", "removes a shared configuration from the project"
+    long_desc <<-DESC
+Examples:
+
+    $ sem projects:shared-configs:remove renderedtext/cli renderedtext/secrets
+    Shared Configuration renderedtext/secrets removed from the project.
+DESC
     def remove(project_name, shared_config_name)
       project = Sem::API::Project.find!(project_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)

data/lib/sem/cli/shared_configs.rb

@@ -1,6 +1,14 @@
 class Sem::CLI::SharedConfigs < Dracula
 
   desc "list", "list shared cofigurations"
+  long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:list
+    ID                                    NAME                 CONFIG FILES  ENV VARS
+    99c7ed43-ac8a-487e-b488-c38bc757a034  renderedtext/tokens             1         0
+    1133ed43-ac8a-487e-b488-c38bc757a044  renderedtext/secrets            0         1
+DESC
   def list
     shared_configs = Sem::API::SharedConfig.all
 
@@ -12,6 +20,17 @@ class Sem::CLI::SharedConfigs < Dracula
   end
 
   desc "info", "show information about a shared configuration"
+  long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:info renderedtext/secrets
+    ID                     99c7ed43-ac8a-487e-b488-c38bc757a034
+    Name                   renderedtext/secrets
+    Config Files           1
+    Environment Variables  0
+    Created                2017-08-01 13:14:40 +0200
+    Updated                2017-08-02 13:14:40 +0200
+DESC
   def info(shared_config_name)
     shared_config = Sem::API::SharedConfig.find!(shared_config_name)
 
@@ -19,6 +38,17 @@ class Sem::CLI::SharedConfigs < Dracula
   end
 
   desc "create", "create a new shared configuration"
+  long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:create renderedtext/secrets
+    ID                     99c7ed43-ac8a-487e-b488-c38bc757a034
+    Name                   renderedtext/secrets
+    Config Files           1
+    Environment Variables  0
+    Created                2017-08-01 13:14:40 +0200
+    Updated                2017-08-02 13:14:40 +0200
+DESC
   def create(shared_config_name)
     shared_config = Sem::API::SharedConfig.create!(shared_config_name)
 
@@ -26,6 +56,17 @@ class Sem::CLI::SharedConfigs < Dracula
   end
 
   desc "rename", "rename a shared configuration"
+  long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:create renderedtext/secrets renderedtext/psst
+    ID                     99c7ed43-ac8a-487e-b488-c38bc757a034
+    Name                   renderedtext/psst
+    Config Files           1
+    Environment Variables  0
+    Created                2017-08-01 13:14:40 +0200
+    Updated                2017-08-02 13:14:40 +0200
+DESC
   def rename(old_shared_config_name, new_shared_config_name)
     old_org_name, _old_name = Sem::SRN.parse_shared_config(old_shared_config_name)
     new_org_name, new_name = Sem::SRN.parse_shared_config(new_shared_config_name)
@@ -39,16 +80,30 @@ class Sem::CLI::SharedConfigs < Dracula
   end
 
   desc "delete", "removes a shared configuration from your organization"
+  long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:delete renderedtext/secrets
+    Deleted shared configuration renderedtext/secrets.
+DESC
   def delete(shared_config_name)
     shared_config = Sem::API::SharedConfig.find!(shared_config_name)
     shared_config.delete!
 
-    puts "Deleted shared configuration #{shared_config_name}"
+    puts "Deleted shared configuration #{shared_config_name}."
   end
 
   class Files < Dracula
 
-    desc "list", "list files in the shared configuration"
+    desc "list", "list files in a shared configuration"
+    long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:files:list renderedtext/secrets
+    ID                                    PATH                      ENCRYPTED?
+    77c7ed43-ac8a-487e-b488-c38bc757a034  /home/runner/a            true
+    11c7ed43-bc8a-a87e-ba88-a38ba757a034  /home/runner/secrets.txt  true
+DESC
     def list(shared_config_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)
       files = shared_config.files
@@ -61,9 +116,14 @@ class Sem::CLI::SharedConfigs < Dracula
     end
 
     desc "add", "add a file to the shared configuration"
-    option "path-on-semaphore", :aliases => "p", :desc => "Path of the file in builds", :required => true
+    option "path-on-semaphore", :aliases => "p", :desc => "Path of the file in builds relative to /home/runner directory", :required => true
     option "local-path", :aliases => "l", :desc => "Location of the file on the local machine", :required => true
-    option "encrypted", :desc => "Encrypt the file", :default => true, :type => :boolean
+    long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:files:add renderedtext/secrets --local-path /tmp/secrets.json --path-on-semaphore secrets.json
+    Added /home/runner/secrets.txt to renderedtext/secrets.
+DESC
     def add(shared_config_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)
 
@@ -74,19 +134,25 @@ class Sem::CLI::SharedConfigs < Dracula
       path = options["path-on-semaphore"]
       content = File.read(local_path)
 
-      shared_config.add_config_file(:path => path, :content => content, :encrypted => options["encrypted"])
+      shared_config.add_config_file(:path => path, :content => content, :encrypted => true)
 
-      puts "Added #{path} to #{shared_config_name}"
+      puts "Added /home/runner/#{path} to #{shared_config_name}."
     end
 
     desc "remove", "remove a file from the shared configuration"
-    option :path, :aliases => "p", :desc => "Path of the file in builds", :required => true
+    option :path, :aliases => "p", :desc => "Path of the file in builds relative to /home/runner directory", :required => true
+    long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:files:remove renderedtext/secrets --path secrets.json
+    Removed /home/runner/secrets.txt from renderedtext/secrets.
+DESC
     def remove(shared_config_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)
 
       shared_config.remove_config_file(options[:path])
 
-      puts "Removed #{options[:path]} from #{shared_config_name}"
+      puts "Removed /home/runner/#{options[:path]} from #{shared_config_name}."
     end
 
   end
@@ -94,6 +160,14 @@ class Sem::CLI::SharedConfigs < Dracula
   class EnvVars < Dracula
 
     desc "list", "list environment variables in the shared configuration"
+    long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:files:list renderedtext/secrets
+    ID                                    NAME    ENCRYPTED?  CONTENT
+    9997ed43-ac8a-487e-b488-c38bc757a034  SECRET  true        aaa
+    1117ed43-tc8a-387e-6488-838bc757a034  TOKEN   true        *encrypted*
+DESC
     def list(shared_config_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)
       env_vars = shared_config.env_vars
@@ -108,17 +182,28 @@ class Sem::CLI::SharedConfigs < Dracula
     desc "add", "add an environment variable to the shared configuration"
     option :name, :aliases => "n", :desc => "Name of the variable", :required => true
     option :content, :aliases => "c", :desc => "Content of the variable", :required => true
-    option :encrypted, :desc => "Encrypt the environment variable", :default => true, :type => :boolean
+    long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:env-vars:add renderedtext/secrets --name TOKEN --content "s3cr3t"
+    Added TOKEN to renderedtext/secrets.
+DESC
     def add(shared_config_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)
 
-      shared_config.add_env_var(:name => options[:name], :content => options[:content], :encrypted => options[:encrypted])
+      shared_config.add_env_var(:name => options[:name], :content => options[:content], :encrypted => true)
 
-      puts "Added #{options[:name]} to #{shared_config_name}"
+      puts "Added #{options[:name]} to #{shared_config_name}."
     end
 
     desc "remove", "remove an environment variable from the shared configuration"
     option :name, :aliases => "n", :desc => "Name of the variable", :required => true
+    long_desc <<-DESC
+Examples:
+
+    $ sem shared-configs:env-vars:remove renderedtext/secrets --name TOKEN
+    Removed TOKEN from renderedtext/secrets.
+DESC
     def remove(shared_config_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)
       name = options[:name]

data/lib/sem/cli/teams.rb

@@ -1,8 +1,16 @@
-class Sem::CLI::Teams < Dracula
+class Sem::CLI::Teams < Dracula # rubocop:disable Metrics/ClassLength
 
   ALLOWED_PERMISSIONS = ["admin", "edit", "read"].freeze
 
-  desc "list", "list teams"
+  desc "list", "list all your teams"
+  long_desc <<-DESC
+Examples:
+
+    $ sem teams:list
+    ID                                    NAME                 PERMISSION  MEMBERS
+    1bc7ed43-ac8a-487e-b488-c38bc757a034  renderedtext/devs    write       2 members
+    1bc7ed43-ac8a-487e-b488-c38bc757a034  renderedtext/admins  write       0 members
+DESC
   def list
     teams = Sem::API::Team.all
 
@@ -14,6 +22,17 @@ class Sem::CLI::Teams < Dracula
   end
 
   desc "info", "show information about a team"
+  long_desc <<-DESC
+Examples:
+
+    $ sem teams:info renderedtext/admins
+    ID          1bc7ed43-ac8a-487e-b488-c38bc757a034
+    Name        renderedtext/admins
+    Permission  edit
+    Members     2 members
+    Created     2017-08-01 13:14:40 +0200
+    Updated     2017-08-02 13:14:40 +0200
+DESC
   def info(team_name)
     team = Sem::API::Team.find!(team_name)
 
@@ -24,6 +43,33 @@ class Sem::CLI::Teams < Dracula
   option :permission, :default => "read",
                       :aliases => "p",
                       :desc => "Permission level of the team in the organization"
+  long_desc <<-DESC
+Examples:
+
+    $ sem teams:create renderedtext/interns
+    ID          1bc7ed43-ac8a-487e-b488-c38bc757a034
+    Name        renderedtext/interns
+    Permission  read
+    Members     0 members
+    Created     2017-08-01 13:14:40 +0200
+    Updated     2017-08-02 13:14:40 +0200
+
+    $ sem teams:create renderedtext/devs --permission edit
+    ID          1bc7ed43-ac8a-487e-b488-c38bc757a034
+    Name        renderedtext/devs
+    Permission  edit
+    Members     0 members
+    Created     2017-08-01 13:14:40 +0200
+    Updated     2017-08-02 13:14:40 +0200
+
+    $ sem teams:create renderedtext/admins --permission admin
+    ID          1bc7ed43-ac8a-487e-b488-c38bc757a034
+    Name        renderedtext/admins
+    Permission  admin
+    Members     0 members
+    Created     2017-08-01 13:14:40 +0200
+    Updated     2017-08-02 13:14:40 +0200
+DESC
   def create(team_name)
     permission = options[:permission]
 
@@ -37,6 +83,17 @@ class Sem::CLI::Teams < Dracula
   end
 
   desc "rename", "change the name of the team"
+  long_desc <<-DESC
+Examples:
+
+    $ sem teams:create renderedtext/interns renderedtext/juniors
+    ID          1bc7ed43-ac8a-487e-b488-c38bc757a034
+    Name        renderedtext/juniors
+    Permission  read
+    Members     0 members
+    Created     2017-08-01 13:14:40 +0200
+    Updated     2017-08-02 13:14:40 +0200
+DESC
   def rename(old_team_name, new_team_name)
     old_org_name, _old_name = Sem::SRN.parse_team(old_team_name)
     new_org_name, new_name = Sem::SRN.parse_team(new_team_name)
@@ -54,6 +111,17 @@ class Sem::CLI::Teams < Dracula
                       :required => true,
                       :aliases => "p",
                       :desc => "Permission level of the team in the organization"
+  long_desc <<-DESC
+Examples:
+
+    $ sem teams:set-permission renderedtext/interns --permission edit
+    ID          1bc7ed43-ac8a-487e-b488-c38bc757a034
+    Name        renderedtext/interns
+    Permission  edit
+    Members     0 members
+    Created     2017-08-01 13:14:40 +0200
+    Updated     2017-08-02 13:14:40 +0200
+DESC
   def set_permission(team_name) # rubocop:disable Style/AccessorMethodName
     permission = options[:permission]
 
@@ -68,6 +136,12 @@ class Sem::CLI::Teams < Dracula
   end
 
   desc "delete", "removes a team from your organization"
+  long_desc <<-DESC
+Examples:
+
+    $ sem teams:delete renderedtext/interns
+    Team renderedtext/interns deleted.
+DESC
   def delete(team_name)
     team = Sem::API::Team.find!(team_name)
     team.delete!
@@ -76,7 +150,16 @@ class Sem::CLI::Teams < Dracula
   end
 
   class Members < Dracula
-    desc "list", "lists members of the team"
+    desc "list", "list members of the team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem teams:members:list renderedtext/interns
+    NAME
+    shiroyasha
+    darko
+    ervinb
+DESC
     def list(team_name)
       team = Sem::API::Team.find!(team_name)
       users = team.users
@@ -89,6 +172,12 @@ class Sem::CLI::Teams < Dracula
     end
 
     desc "add", "add a user to the team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem teams:members:add renderedtext/interns shiroyasha
+    User shiroyasha added to the team.
+DESC
     def add(team_name, username)
       team = Sem::API::Team.find!(team_name)
       team.add_user(username)
@@ -96,7 +185,13 @@ class Sem::CLI::Teams < Dracula
       puts "User #{username} added to the team."
     end
 
-    desc "remove", "removes a user from the team"
+    desc "remove", "remove a user from the team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem teams:members:remove renderedtext/interns shiroyasha
+    User shiroyasha removed from the team.
+DESC
     def remove(team_name, username)
       team = Sem::API::Team.find!(team_name)
       team.remove_user(username)
@@ -106,7 +201,16 @@ class Sem::CLI::Teams < Dracula
   end
 
   class Projects < Dracula
-    desc "list", "lists projects in a team"
+    desc "list", "list projects in a team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem team:projects:list renderedtext/devs
+    NAME
+    ID                                    NAME
+    99c7ed43-ac8a-487e-b488-c38bc757a034  renderedtext/cli
+    12c7ed43-4444-487e-b488-c38bc757a034  renderedtext/api
+DESC
     def list(team_name)
       team = Sem::API::Team.find!(team_name)
       projects = team.projects
@@ -119,6 +223,12 @@ class Sem::CLI::Teams < Dracula
     end
 
     desc "add", "add a project to a team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem team:projects:add renderedtext/devs renderedtext/cli
+    Project renderedtext/cli added to the team.
+DESC
     def add(team_name, project_name)
       team = Sem::API::Team.find!(team_name)
       project = Sem::API::Project.find!(project_name)
@@ -128,7 +238,13 @@ class Sem::CLI::Teams < Dracula
       puts "Project #{project_name} added to the team."
     end
 
-    desc "remove", "removes a project from the team"
+    desc "remove", "remove a project from the team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem team:projects:remove renderedtext/devs renderedtext/cli
+    Project renderedtext/cli removed from the team.
+DESC
     def remove(team_name, project_name)
       team = Sem::API::Team.find!(team_name)
       project = Sem::API::Project.find!(project_name)
@@ -141,6 +257,14 @@ class Sem::CLI::Teams < Dracula
 
   class SharedConfigs < Dracula
     desc "list", "list shared configurations in a team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem team:shared-configs:list renderedtext/devs
+    ID                                    NAME                 CONFIG FILES  ENV VARS
+    99c7ed43-ac8a-487e-b488-c38bc757a034  renderedtext/tokens             1         0
+    1133ed43-ac8a-487e-b488-c38bc757a044  renderedtext/secrets            0         1
+DESC
     def list(team_name)
       team = Sem::API::Team.find!(team_name)
       configs = team.shared_configs
@@ -153,6 +277,12 @@ class Sem::CLI::Teams < Dracula
     end
 
     desc "add", "add a shared configuration to a team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem team:shared-configs:add renderedtext/devs renderedtext/secrets
+    Shared Configuration renderedtext/secrets added to the team.
+DESC
     def add(team_name, shared_config_name)
       team = Sem::API::Team.find!(team_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)
@@ -163,6 +293,12 @@ class Sem::CLI::Teams < Dracula
     end
 
     desc "remove", "removes a shared Configuration from the team"
+    long_desc <<-DESC
+Examples:
+
+    $ sem team:shared-configs:remove renderedtext/devs renderedtext/secrets
+    Shared Configuration renderedtext/secrets removed from the team.
+DESC
     def remove(team_name, shared_config_name)
       team = Sem::API::Team.find!(team_name)
       shared_config = Sem::API::SharedConfig.find!(shared_config_name)

data/lib/sem/cli.rb

@@ -12,10 +12,15 @@ module Sem
       puts Sem::VERSION
     end
 
-    desc "login", "Log in to semaphore from the command line"
+    desc "login", "Log in to Semaphore from the command line"
     option "auth-token", :required => true
     long_desc <<-DESC
-You can find your auth-token on the bottom of the users settings page https://semaphoreci.com/users/edit.
+Examples:
+
+    $ sem login --auth-token abcd12345
+    Your credentials have been saved to #{Sem::Configuration::CREDENTIALS_PATH}."
+
+You can find your auth-token on the bottom of the users settings page <https://semaphoreci.com/users/edit>.
 DESC
     def login
       auth_token = options["auth-token"]
@@ -30,10 +35,16 @@ DESC
     end
 
     desc "logout", "Log out from semaphore"
+    long_desc <<-DESC
+Examples:
+
+    $ sem logout
+    Logged out.
+DESC
     def logout
       Sem::Configuration.delete_auth_token
 
-      puts "Loged out."
+      puts "Logged out."
     end
 
     register "orgs", "manage organizations", Sem::CLI::Orgs

data/lib/sem/version.rb

@@ -1,3 +1,3 @@
 module Sem
-  VERSION = "0.6.2".freeze
+  VERSION = "0.7.0".freeze
 end

data/lib/sem/views/files.rb

@@ -4,7 +4,7 @@ class Sem::Views::Files < Sem::Views::Base
     header = ["ID", "PATH", "ENCRYPTED?"]
 
     body = files.map do |file|
-      [file.id, file.path, file.encrypted?]
+      [file.id, "/home/runner/#{file.path}", file.encrypted?]
     end
 
     print_table([header, *body])

data/sem.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "semaphore_client", "2.8.1"
-  spec.add_dependency "dracula", "~> 0.4.0"
+  spec.add_dependency "dracula", "~> 0.6.0"
   spec.add_dependency "pmap", "~> 1.1.1"
 
   spec.add_development_dependency "bundler", "~> 1.14"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sem
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Igor Šarčević
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2017-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semaphore_client
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: pmap
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +193,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/generate_json_structure
 - bin/setup
 - exe/sem
 - guides.md