Skip to content

Commit 779888e

Browse files
committed
refactor(penify_hook): enhance CLI help text for clarity and JIRA integration
1 parent f252c16 commit 779888e

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

penify_hook/main.py

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,9 @@ def main():
4545

4646
# Multi-line description using triple quotes
4747
description = """Penify CLI tool for:
48-
1. AI commit message generation
49-
2. Using JIRA descriptions to enhance commit messages
50-
3. Generating code documentation for code files
51-
4. Installing Git hooks for automatic documentation generation
52-
5. For more information, visit https://docs.penify.dev/
48+
1. AI commit message generation with JIRA integration to enhance commit messages. By default, it uses local-LLM but can be configured to use Penify's LLM.
49+
2. Generating Code Documentation, it requires SignUp to Penify
50+
3. For more information, visit https://docs.penify.dev/
5351
"""
5452

5553
parser = argparse.ArgumentParser(description=description, formatter_class=argparse.RawDescriptionHelpFormatter)
@@ -68,7 +66,7 @@ def main():
6866
# ===== BASIC COMMANDS (No login required) =====
6967

7068
# Subcommand: commit
71-
commit_parser = subparsers.add_parser("commit", help="Generate smart commit messages (no login required).")
69+
commit_parser = subparsers.add_parser("commit", help="Generate smart commit messages using local-LLM(no login required).")
7270
commit_parser.add_argument("-gf", "--git_folder_path", help="Path to the folder with git.", default=os.getcwd())
7371
commit_parser.add_argument("-m", "--message", required=False, help="Commit with contextual commit message.", default="N/A")
7472
commit_parser.add_argument("-e", "--terminal", required=False, help="Open edit terminal", default="False")
@@ -82,7 +80,7 @@ def main():
8280
commit_parser.add_argument("--jira-api-token", help="JIRA API token")
8381

8482
# Subcommand: config
85-
config_parser = subparsers.add_parser("config", help="Configure local settings (no login required).")
83+
config_parser = subparsers.add_parser("config", help="Configure local-LLM and JIRA.")
8684
config_subparsers = config_parser.add_subparsers(title="config_type", dest="config_type")
8785

8886
# Config subcommand: llm
@@ -115,7 +113,7 @@ def main():
115113
"""
116114

117115
# Advanced Subcommand: docgen
118-
docgen_parser = subparsers.add_parser("docgen", help="[REQUIRES LOGIN] Generate code documentation for the file or folder", description=docgen_description, formatter_class=argparse.RawDescriptionHelpFormatter)
116+
docgen_parser = subparsers.add_parser("docgen", help="[REQUIRES LOGIN] Generate code documentation for the Git diff, file or folder.", description=docgen_description, formatter_class=argparse.RawDescriptionHelpFormatter)
119117
docgen_subparsers = docgen_parser.add_subparsers(title="docgen_subcommand", dest="docgen_subcommand")
120118

121119
# Docgen main options (for direct documentation generation)

0 commit comments

Comments
 (0)