@@ -15,7 +15,7 @@ The `commit` command allows you to generate smart, AI-powered commit messages fo
1515## Basic Usage
1616
1717``` bash
18- penifycli commit
18+ penify commit
1919```
2020
2121By default, this command:
@@ -30,7 +30,7 @@ By default, this command:
3030Provide context for the commit message generation:
3131
3232``` bash
33- penifycli commit -m " Fix login flow"
33+ penify commit -m " Fix login flow"
3434```
3535
3636This hint helps the AI understand your intention and improves the quality of the generated message.
@@ -40,7 +40,7 @@ This hint helps the AI understand your intention and improves the quality of the
4040Open an editor to review and edit the generated commit message before committing:
4141
4242``` bash
43- penifycli commit -e
43+ penify commit -e
4444```
4545
4646This opens your default Git editor with the generated message for review.
@@ -50,7 +50,7 @@ This opens your default Git editor with the generated message for review.
5050Generate a detailed commit message with both title and description:
5151
5252``` bash
53- penifycli commit -d
53+ penify commit -d
5454```
5555
5656Without this flag, only the commit title is generated.
@@ -62,32 +62,32 @@ You can combine these options for different workflows:
6262### Generate Title Only with Context
6363
6464``` bash
65- penifycli commit -m " Update login UI"
65+ penify commit -m " Update login UI"
6666```
6767
6868### Generate Title and Description with Context
6969
7070``` bash
71- penifycli commit -m " Update login UI" -d
71+ penify commit -m " Update login UI" -d
7272```
7373
7474### Generate and Edit Full Commit Message
7575
7676``` bash
77- penifycli commit -d -e
77+ penify commit -d -e
7878```
7979
8080### Generate, Edit, and Provide Context
8181
8282``` bash
83- penifycli commit -m " Refactor authentication" -d -e
83+ penify commit -m " Refactor authentication" -d -e
8484```
8585
8686## LLM and JIRA Integration
8787
8888### Using Local LLM
8989
90- If you've configured a local LLM using ` penifycli config llm` , the commit command will automatically use it for message generation.
90+ If you've configured a local LLM using ` penify config llm` , the commit command will automatically use it for message generation.
9191
9292Benefits:
9393- Privacy: your code changes don't leave your machine
@@ -96,7 +96,7 @@ Benefits:
9696
9797### JIRA Enhancement
9898
99- If you've configured JIRA integration using ` penifycli config jira` , the commit command will:
99+ If you've configured JIRA integration using ` penify config jira` , the commit command will:
100100
1011011 . Detect JIRA issue references in your changes
1021022 . Fetch issue details from your JIRA instance
@@ -119,11 +119,11 @@ PROJ-123: Fix authentication bug in login flow
119119For the ` commit ` command to work:
120120
1211211 . You must have configured either:
122- - Local LLM via ` penifycli config llm` , OR
123- - Logged in via ` penifycli login`
122+ - Local LLM via ` penify config llm` , OR
123+ - Logged in via ` penify login`
124124
1251252 . For JIRA enhancement (optional):
126- - Configure JIRA via ` penifycli config jira`
126+ - Configure JIRA via ` penify config jira`
127127
128128## Examples
129129
@@ -134,7 +134,7 @@ For the `commit` command to work:
134134git add .
135135
136136# Generate commit message
137- penifycli commit
137+ penify commit
138138
139139# Commit with the generated message
140140git commit -m " Generated message here"
@@ -148,7 +148,7 @@ git add .
148148
149149# Generate detailed commit message with JIRA integration,
150150# provide context, and open editor for review
151- penifycli commit -m " Fix login issue" -d -e
151+ penify commit -m " Fix login issue" -d -e
152152
153153# The commit is automatically completed after you save and exit the editor
154154```
@@ -158,8 +158,8 @@ penifycli commit -m "Fix login issue" -d -e
158158### Common Issues
159159
1601601 . ** "No LLM model or API token provided"**
161- - Run ` penifycli config llm` to configure a local LLM, or
162- - Run ` penifycli login` to authenticate with Penify
161+ - Run ` penify config llm` to configure a local LLM, or
162+ - Run ` penify login` to authenticate with Penify
163163
1641642 . ** "Failed to connect to JIRA"**
165165 - Check your JIRA configuration with ` cat ~/.penify `
0 commit comments