pray-cli 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9a9ce52fe79c346f5ea5bf9516fb6ad813da69028fcf27c4fe166946fec77fc
-  data.tar.gz: 39062dc10eee030334edda7c10a9a71749a93c887cf2483f218ab7a9ceefcb68
+  metadata.gz: 0b96847ff63e2123258b7dcedd5c074392941b6654f20d02767b0a221ecbeb8e
+  data.tar.gz: 256f98e161876f0145790fde9a581eda5747267823e3e2bdf30beeabfbdc477b
 SHA512:
-  metadata.gz: 8097c2dab4ec198b55d8fc8803ed602f82fa6afef6096602b539f25b501b597da0bcd53108de519422b2216b624d0060e21020cb7abf531e700eaaa5a83eeac5
-  data.tar.gz: f8bde377e7a44de1aeec8591c92e4f478e2758386067585ac17c07afbb0af71946c37dbd7f6a58b4035ced2e6141f32ea2cd20372f0eafe195c1075ea43d3a37
+  metadata.gz: 4d7d234f3c63b528eaec20fd9d0e1eba462df4128c691b56daa7b6eb3e943f5ed56259c59335e91eb12501385cda68b1ccbce4179bf62f0aab896bbcc4e4edf8
+  data.tar.gz: 989b8e9f72b95740f4328e5ae584b60c467d33c3a36a2cc8388ca567ab014adf6449264d22ac96610b6f66feffc3c6d96d779f39c5119d8dc7e7a780efbf1a0c

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## 1.7.0 (2026-07-29)
+
+- Reshape CLI help around a `Usage` synopsis and `Options` block; cover every listed command; point unknown-command errors at `pray --help`.
+
 ## 1.6.0 (2026-07-29)
 
 - Run tests with polyrun parallel RSpec, coverage gate, Makefile lint/test, and RBS validate.

data/lib/pray/cli/help.rb

@@ -3,8 +3,6 @@
 module Pray
   module CLI
     module Help
-      DOCS_URL = "https://github.com/kiskolabs/pray"
-
       WORKFLOW_COMMANDS = [
         "install [--locked|--frozen|--offline]  resolve, render, and write Prayfile.lock",
         "plan [--remote]                        preview materialization changes",
@@ -16,10 +14,10 @@ module Pray
       ].freeze
 
       PACKAGE_COMMANDS = [
-        "add <name> [constraint] [--path PATH]",
-        "remove <name>",
+        "add <name> [constraint] [--path PATH]  declare a package in Prayfile",
+        "remove <name>                          remove a package from Prayfile",
         "update [package] [--major] [--latest] [--dry-run] [--json]",
-        "unlock <package>",
+        "unlock <package>                       clear a locked package pin",
         "vendor                                 copy resolved packages locally",
         "clean                                  remove local cache and vendor trees"
       ].freeze
@@ -38,23 +36,29 @@ module Pray
 
       INSPECT_COMMANDS = [
         "list                                   list declared packages",
-        "outdated [--remote]                      show constraint vs resolved versions",
-        "explain <package>                        show why a package was selected",
-        "tree                                     print the dependency tree"
+        "outdated [--remote]                    show constraint vs resolved versions",
+        "explain <package>                      show why a package was selected",
+        "tree                                   print the dependency tree"
       ].freeze
 
       META_COMMANDS = [
-        "init [--targets tool_a,tool_b]",
+        "init [--targets tool_a,tool_b]         create a starter Prayfile",
         "prayer init                            scaffold a prayer package",
         "repo init                              scaffold a distribution root",
         "manifest                               print canonical Prayfile JSON",
         "package                                build a distributable prayer archive",
-        "version | -V | --version"
+        "version | -V | --version               print the pray CLI version"
+      ].freeze
+
+      GLOBAL_OPTIONS = [
+        "--no-input            disable prompts",
+        "--rm                  use an ephemeral home directory",
+        "--trust [--global]    import trust on first use"
       ].freeze
 
       COMMAND_HELP = {
         "install" => <<~TEXT.strip,
-          install — resolve packages, render targets, and update Prayfile.lock
+          resolve packages, render targets, and update Prayfile.lock
 
           Usage: pray install [--locked|--frozen|--offline]
 
@@ -63,7 +67,7 @@ module Pray
           --offline  use cache only
         TEXT
         "verify" => <<~TEXT.strip,
-          verify — check rendered files against Prayfile.lock
+          check rendered files against Prayfile.lock
 
           Usage: pray verify [--strict]
 
@@ -71,56 +75,120 @@ module Pray
           With --strict, any finding fails with exit code 6.
         TEXT
         "drift" => <<~TEXT.strip,
-          drift — report differences between lockfile and current resolution
+          report differences between lockfile and current resolution
 
           Usage: pray drift [--semantic]
 
           Exits with code 6 when drift is found.
         TEXT
+        "render" => <<~TEXT.strip,
+          render targets without updating the lockfile
+
+          Usage: pray render [--check]
+        TEXT
+        "format" => <<~TEXT.strip,
+          rewrite Prayfile to recommended destination DSL
+
+          Usage: pray format
+                 pray fmt
+        TEXT
+        "fmt" => <<~TEXT.strip,
+          rewrite Prayfile to recommended destination DSL
+
+          Usage: pray format
+                 pray fmt
+        TEXT
         "update" => <<~TEXT.strip,
-          update — refresh package versions within constraints
+          refresh package versions within constraints
 
           Usage: pray update [package] [--major] [--latest] [--dry-run] [--json]
         TEXT
         "plan" => <<~TEXT.strip,
-          plan — preview install/apply changes
+          preview install/apply changes
 
           Usage: pray plan [--remote]
         TEXT
-        "apply" => "apply — materialize the current resolution plan\n\nUsage: pray apply",
+        "apply" => "materialize the current resolution plan\n\nUsage: pray apply",
+        "add" => <<~TEXT.strip,
+          declare a package in Prayfile
+
+          Usage: pray add <name> [constraint] [--path PATH]
+        TEXT
+        "remove" => "remove a package from Prayfile\n\nUsage: pray remove <name>",
+        "unlock" => "clear a locked package pin\n\nUsage: pray unlock <package>",
+        "vendor" => "copy resolved packages locally\n\nUsage: pray vendor",
+        "clean" => "remove local cache and vendor trees\n\nUsage: pray clean",
+        "publish" => <<~TEXT.strip,
+          upload packages to a registry or local root
+
+          Usage: pray publish --root PATH [--server URL ...]
+        TEXT
+        "login" => <<~TEXT.strip,
+          authenticate to a registry server
+
+          Usage: pray login --server URL --email EMAIL
+        TEXT
+        "serve" => <<~TEXT.strip,
+          run a local registry server
+
+          Usage: pray serve [--root PATH] [--host HOST] [--port PORT] [--stdio]
+        TEXT
+        "sync" => <<~TEXT.strip,
+          sync packages with peer registries
+
+          Usage: pray sync [--root PATH] [--peer URL ...]
+        TEXT
+        "confess" => <<~TEXT.strip,
+          record an acceptance or rejection for a package confession
+
+          Usage: pray confess <package> | --from-lock SPAN_ID [--accepted|--rejected]
+        TEXT
         "trust" => <<~TEXT.strip,
-          trust — manage client trust policy for remote sources
+          manage client trust policy for remote sources
 
           Usage: pray trust <subcommand>
 
           Subcommands: list, show, add-key, remove-key, set-signed, set-allow, import-repo, import-registry, check
         TEXT
-        "init" => <<~TEXT.strip,
-          init — create a starter Prayfile
+        "list" => "list declared packages\n\nUsage: pray list",
+        "outdated" => <<~TEXT.strip,
+          show constraint vs resolved versions
 
-          Usage: pray init [--targets tool_a,tool_b]
+          Usage: pray outdated [--remote]
         TEXT
-        "add" => <<~TEXT.strip,
-          add — declare a package in Prayfile
+        "explain" => <<~TEXT.strip,
+          show why a package was selected
 
-          Usage: pray add <name> [constraint] [--path PATH]
+          Usage: pray explain <package>
         TEXT
-        "publish" => <<~TEXT.strip,
-          publish — upload packages to a registry or local root
+        "tree" => "print the dependency tree\n\nUsage: pray tree",
+        "init" => <<~TEXT.strip,
+          create a starter Prayfile
 
-          Usage: pray publish --root PATH [--server URL ...]
+          Usage: pray init [--targets tool_a,tool_b]
         TEXT
-        "serve" => <<~TEXT.strip
-          serve — run a local registry server
+        "prayer" => "scaffold a prayer package\n\nUsage: pray prayer init",
+        "repo" => "scaffold a distribution root\n\nUsage: pray repo init",
+        "manifest" => "print canonical Prayfile JSON\n\nUsage: pray manifest",
+        "package" => "build a distributable prayer archive\n\nUsage: pray package",
+        "version" => <<~TEXT.strip,
+          print the pray CLI version
+
+          Usage: pray version
+                 pray -V | --version
+        TEXT
+        "help" => <<~TEXT.strip
+          show help for pray or one command
 
-          Usage: pray serve [--root PATH] [--host HOST] [--port PORT] [--stdio]
+          Usage: pray help [command]
+                 pray [command] --help
         TEXT
       }.freeze
 
       module_function
 
       def print_concise_help
-        puts "pray — reproducible inference input for projects"
+        puts "Usage: pray [OPTIONS] <COMMAND>"
         puts
         puts "Declare shared instructions in Prayfile, lock versions, and render tool-specific output."
         puts
@@ -133,9 +201,10 @@ module Pray
         puts
         print_command_groups
         puts
-        puts "Run `pray help <command>` or `pray <command> --help` for one command."
-        puts "Documentation: #{DOCS_URL}"
-        puts "Exit codes: 0 success; 2 usage/parse; 3 resolution; 4 integrity; 5 render; 6 verify; 8 unsupported."
+        puts "Options:"
+        GLOBAL_OPTIONS.each { |line| puts "  #{line}" }
+        puts
+        puts "See 'pray help <command>' or 'pray <command> --help' for details on a command."
       end
 
       def print_command_help(command)
@@ -143,25 +212,26 @@ module Pray
         return false unless text
 
         puts text
-        puts
-        puts "Documentation: #{DOCS_URL}"
         true
       end
 
       def print_command_groups
-        puts "Workflow:"
-        WORKFLOW_COMMANDS.each { |line| puts "  #{line}" }
-        puts "Packages:"
-        PACKAGE_COMMANDS.each { |line| puts "  #{line}" }
-        puts "Distribution:"
-        DISTRIBUTION_COMMANDS.each { |line| puts "  #{line}" }
-        puts "Trust:"
-        TRUST_COMMANDS.each { |line| puts "  #{line}" }
-        puts "Inspect:"
-        INSPECT_COMMANDS.each { |line| puts "  #{line}" }
-        puts "Meta:"
-        META_COMMANDS.each { |line| puts "  #{line}" }
-        puts "Global flags: --no-input (disable prompts), --rm (ephemeral home), --trust [--global]"
+        print_group("Workflow", WORKFLOW_COMMANDS)
+        puts
+        print_group("Packages", PACKAGE_COMMANDS)
+        puts
+        print_group("Distribution", DISTRIBUTION_COMMANDS)
+        puts
+        print_group("Trust", TRUST_COMMANDS)
+        puts
+        print_group("Inspect", INSPECT_COMMANDS)
+        puts
+        print_group("Meta", META_COMMANDS)
+      end
+
+      def print_group(title, lines)
+        puts "#{title}:"
+        lines.each { |line| puts "  #{line}" }
       end
     end
   end

data/lib/pray/cli/suggest.rb

@@ -14,7 +14,8 @@ module Pray
       def unknown_command_message(command)
         message = "unknown command: #{command}"
         suggestion = suggest_command(command, TOP_LEVEL_COMMANDS)
-        suggestion ? "#{message}\nDid you mean `#{suggestion}`?" : message
+        message = "#{message}\nDid you mean `#{suggestion}`?" if suggestion
+        "#{message}\nSee 'pray --help'."
       end
 
       def suggest_command(input, candidates)

data/lib/pray/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Pray
-  VERSION = "1.6.0"
-  GENERATED_BY = "pray 1.6.0"
+  VERSION = "1.7.0"
+  GENERATED_BY = "pray 1.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pray-cli
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Andrei Makarov