pike13-cli 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d9d5c24ee525f89caa0a7f089ad717f7b0b417ca884ffc3f61e9b209dc9e524
-  data.tar.gz: c406d8361b7f586c8b2b8331e30a32872a846c709242e26d0d24b0d93cce36d3
+  metadata.gz: 2a25727e462bc16901a2b280d632ba8f1724357b6f707375ffddbd66738c4657
+  data.tar.gz: 71c87d7cc6ed410fdea1122c1bb886db60eb16d715156079aa156289177c95fd
 SHA512:
-  metadata.gz: bbfb3bdbbff055122320ddb9f82c4182b189396557b1148d53da52a08c6f445d95dd3abd4d60a95c50b64692266ca90723fba1b6d4cd4368e8209685b3cb149d
-  data.tar.gz: 00cad077b09d7bef5b65e00085308f36c11420909334f2ea3fef6e9f4bcb4af742122560f83d64e55dfa7ff7a9f54e59aa2b04a54b5b4205e3bd55393b2e73c9
+  metadata.gz: 1cfe95f61afb73f1f41d35af4496c881ff4bcdbd82797379a7b52848b2e4bee078e62a463ed9f67a4431a7a5e2b69db1775d839ee406997cefc1f09836f22c78
+  data.tar.gz: d27c75165cac36d07447b22f12f4d066b6ea9201f57e86635d6c31e3a3b863bd48e3075022b0aa556f2d6d6d1a70c591170bda61aec526fbdf0a9121128d93c6

data/CHANGELOG.md

@@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - 2025-11-19
+
+### Fixed
+- **Help Command Documentation** - Improved help command clarity and consistency
+  - Updated README.md with better help command examples
+  - Enhanced help command display logic in CLI base commands
+  - Improved user experience for discovering available commands
+
+## [0.2.1] - 2025-11-18
+
+### Fixed
+- **Help Command Display Issue** - Fixed help commands showing incorrect singular forms instead of intended plural forms
+  - `pike13 desk people --help` now shows `pike13 desk people create/list/get/delete/me/search/update` instead of `pike13 desk person create/list/get/delete/me/search/update`
+  - `pike13 desk staff --help` now shows `pike13 desk staff get/list/help/me` instead of `pike13 desk staffmember get/list/help/me`
+  - `pike13 front plan_products --help` now shows `pike13 front plan_products get/list/help` instead of `pike13 front planproduct get/list/help`
+  - `pike13 account people --help` now shows `pike13 account people help/list` instead of `pike13 account person help/list`
+  - Applied `base_usage` overrides to ensure help commands display correct plural naming
+
 ## [0.2.0] - 2025-11-18
 
 ### Added

data/README.md

@@ -530,14 +530,33 @@ pike13 report clients query --progress --format table
 
 ```bash
 # Help for any command
-pike13 help
-pike13 desk help
-pike13 desk people help
-pike13 desk event_occurrences help
-pike13 desk event_occurrence_notes help
-pike13 desk custom_fields help
-pike13 desk forms_of_payment help
-pike13 report help
+pike13 --help
+pike13 -h
+
+pike13 desk --help
+pike13 desk -h
+
+pike13 desk people --help
+pike13 desk people -h
+
+pike13 desk event_occurrences --help
+pike13 desk event_occurrences -h
+
+pike13 desk event_occurrence_notes --help
+pike13 desk event_occurrence_notes -h
+
+pike13 desk custom_fields --help
+pike13 desk custom_fields -h
+
+pike13 desk forms_of_payment --help
+pike13 desk forms_of_payment -h
+
+pike13 report --help
+pike13 report -h
+
+# Help for specific commands
+pike13 desk people list --help
+pike13 report clients query --help
 
 # Verbose output (show HTTP requests and detailed debugging)
 pike13 desk people list --verbose
@@ -939,19 +958,30 @@ pike13 report clients query --format csv > clients.csv
 ### Getting Help
 
 ```bash
-# View help for any command
-pike13 help
-pike13 desk help
-pike13 desk people help
-pike13 desk event_occurrences help
-pike13 desk custom_fields help
-pike13 desk forms_of_payment help
+# View help for any command (use --help or -h flags)
+pike13 --help
+pike13 -h
+
+pike13 desk --help
+pike13 desk -h
+
+pike13 desk people --help
+pike13 desk people -h
+
+pike13 desk event_occurrences --help
+pike13 desk event_occurrences -h
+
+pike13 desk custom_fields --help
+pike13 desk custom_fields -h
+
+pike13 desk forms_of_payment --help
+pike13 desk forms_of_payment -h
 
 # Check your environment
 pike13 version
 
 # List all available commands
-pike13 help | grep -A 100 "Commands:"
+pike13 --help | grep -A 100 "Commands:"
 ```
 
 ## Development
@@ -969,7 +999,7 @@ gem build pike13-cli.gemspec
 gem install pike13-cli-0.1.0.beta.gem
 
 # Test the CLI
-pike13 help
+pike13 --help
 
 # Run tests
 bundle exec rspec

data/lib/pike13/cli/commands/account/person.rb

@@ -5,7 +5,11 @@ module Pike13
     module Commands
       class Account < Base
         class Person < Base
-          desc "list", "List all people across businesses"
+          # Override the command name display to use "people" instead of "person"
+          def self.base_usage
+            "account people"
+          end
+          desc "list", "List all people across your businesses"
           format_options
           def list
             handle_error do

data/lib/pike13/cli/commands/base.rb

@@ -11,6 +11,15 @@ module Pike13
         # Inherit verbose and quiet options from parent Runner
         class_option :verbose, type: :boolean, aliases: "-v", desc: "Verbose output"
         class_option :quiet, type: :boolean, aliases: "-q", desc: "Quiet mode (errors only)"
+        class_option :help, type: :boolean, aliases: "-h", desc: "Show help information"
+
+        # Override help to show command-specific options
+        def self.handle_argument_error(task, error, _type)
+          puts "Error: #{error.message}"
+          puts
+          puts "Run '#{basename} #{base_usage} #{task.name} --help' for more information."
+          exit 1
+        end
 
         # Auto-generate base_usage from class name
         def self.base_usage

data/lib/pike13/cli/commands/desk/person.rb

@@ -5,6 +5,10 @@ module Pike13
     module Commands
       class Desk < Base
         class Person < Base
+          # Override the command name display to use "people" instead of "person"
+          def self.base_usage
+            "desk people"
+          end
           desc "list", "List all people"
           map "ls" => :list
           format_options

data/lib/pike13/cli/commands/desk/staff_member.rb

@@ -5,6 +5,10 @@ module Pike13
     module Commands
       class Desk < Base
         class StaffMember < Base
+          # Override the command name display to use "staff" instead of "staffmember"
+          def self.base_usage
+            "desk staff"
+          end
           desc "list", "List all staff"
           map "ls" => :list
           format_options

data/lib/pike13/cli/commands/front/person.rb

@@ -5,6 +5,10 @@ module Pike13
     module Commands
       class Front < Base
         class Person < Base
+          # Override the command name display to use "people" instead of "person"
+          def self.base_usage
+            "front people"
+          end
           desc "me", "Get current authenticated client user"
           format_options
           def me

data/lib/pike13/cli/commands/front/plan_product.rb

@@ -5,6 +5,10 @@ module Pike13
     module Commands
       class Front < Base
         class PlanProduct < Base
+          # Override the command name display to use "plan_products" instead of "planproduct"
+          def self.base_usage
+            "front plan_products"
+          end
           desc "list", "List all plan products"
           format_options
           def list

data/lib/pike13/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Pike13
   module CLI
-    VERSION = "0.2.0"
+    VERSION = "0.2.2"
   end
 end

data/lib/pike13/cli.rb

@@ -17,6 +17,7 @@ module Pike13
     class Runner < Thor
       class_option :verbose, type: :boolean, aliases: "-v", desc: "Verbose output"
       class_option :quiet, type: :boolean, aliases: "-q", desc: "Quiet mode (errors only)"
+      class_option :help, type: :boolean, aliases: "-h", desc: "Show help information"
 
       desc "desk SUBCOMMAND", "Desk namespace (staff interface)"
       subcommand "desk", Commands::Desk
@@ -56,7 +57,8 @@ module Pike13
         # Skip config for help commands
         first_arg = given_args.first
         is_help_command = first_arg == "help" || first_arg == "version" ||
-                          given_args.any? { |arg| arg.include?("--help") }
+                          given_args.any? { |arg| arg.include?("--help") || arg.include?("-h") } ||
+                          given_args.include?("help") # Catch help subcommand at any level
         unless is_help_command || given_args.empty?
           Config.configure_pike13!
         end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: pike13-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
-- Pike13 CLI Contributors
+- Juan Huttemann
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Command-line interface for Pike13 API
 test_files: []