Skip to content

Commit dc59ac8

Browse files
committed
refactor: Update CLI commands to use 'penify' instead of 'penifycli' for consistency across documentation
1 parent 4917e35 commit dc59ac8

14 files changed

Lines changed: 117 additions & 115 deletions

.vitepress/config.mts

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,6 @@ export default defineConfig({
125125
},
126126
],
127127
}]},
128-
{items: [{
129-
text: "💰 Penify Pricing",
130-
link: "/docs/penify-pricing.md",
131-
}]},
132128
{
133129
items: [{
134130
text: "💠 Penify Dashboard",
@@ -160,17 +156,19 @@ export default defineConfig({
160156
text: "🖥️ Penify CLI",
161157
link: "/docs/penify-cli",
162158
items:[{
163-
text: "📝 Detailed Usage guide",
159+
text: "📝 Usage guide",
164160
link: "/docs/penify-cli-detailed-usage",
161+
collapsed: true,
162+
items: [
163+
{
164+
text: "🔑 Create API Keys",
165+
link: "/docs/Creating-API-Keys-in-Penify",
166+
}]
165167
},
166168
{
167-
text: "🔑 Create API Token",
168-
link: "/docs/Creating-API-Keys-in-Penify",
169-
},
170-
{
171-
text: "📝 Configure LLM + JIRA",
172-
link: "/docs/config-cli-documentation",
173-
collapsed: true,
169+
text: "📝 Configure Setup",
170+
link: "/docs/config-cli-documentation#llm-configuration",
171+
collapsed: false,
174172
items: [
175173
{
176174
text: "📝 Local LLM",
@@ -179,6 +177,10 @@ export default defineConfig({
179177
{
180178
text: "📝 Jira",
181179
link: "/docs/config-cli-documentation#using-local-llm#jira-configuration",
180+
},
181+
{
182+
text: "📝 Commit Hooks",
183+
link: "/docs/post-commit-hooks-cli",
182184
}]
183185
},
184186
{
@@ -207,14 +209,14 @@ export default defineConfig({
207209
{
208210
text: "📝 Commit Documentation",
209211
link: "/docs/commit-documentation-cli",
210-
},
211-
{
212-
text: "📝 Post-Commit Hooks",
213-
link: "/docs/post-commit-hooks-cli",
214212
}]
215213
}
216214
],
217215
},
216+
{items: [{
217+
text: "💰 Penify Pricing",
218+
link: "/docs/penify-pricing.md",
219+
}]},
218220
],
219221

220222
socialLinks: [

docs/commit-documentation-cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Penify-CLI can generate documentation of classes/functions for your recent chang
1616
Login to Penify, make sure you have an account or you have [created an account](https://www.penify.dev/).
1717

1818
```bash
19-
penifycli login
19+
penify login
2020
```
2121

2222
## Usage
@@ -25,7 +25,7 @@ To document recent Git changes:
2525

2626
```bash
2727
cd /path/to/folder
28-
penifycli doc-gen
28+
penify doc-gen
2929
```
3030

3131
### Options

docs/commit-summary-generation-cli.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -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

2121
By default, this command:
@@ -30,7 +30,7 @@ By default, this command:
3030
Provide 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

3636
This 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
4040
Open 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

4646
This 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.
5050
Generate a detailed commit message with both title and description:
5151

5252
```bash
53-
penifycli commit -d
53+
penify commit -d
5454
```
5555

5656
Without 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

9292
Benefits:
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

101101
1. Detect JIRA issue references in your changes
102102
2. Fetch issue details from your JIRA instance
@@ -119,11 +119,11 @@ PROJ-123: Fix authentication bug in login flow
119119
For the `commit` command to work:
120120

121121
1. 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

125125
2. 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:
134134
git add .
135135

136136
# Generate commit message
137-
penifycli commit
137+
penify commit
138138

139139
# Commit with the generated message
140140
git 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

160160
1. **"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

164164
2. **"Failed to connect to JIRA"**
165165
- Check your JIRA configuration with `cat ~/.penify`

docs/config-cli-documentation.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,17 @@ Penify CLI stores configuration in a JSON file at `~/.penify/config.json`. The c
2424

2525
```bash
2626
# Configure LLM settings
27-
penifycli config llm
27+
penify config llm
2828

2929
# Configure JIRA integration
30-
penifycli config jira
30+
penify config jira
3131
```
3232

3333
## LLM Configuration
3434

3535
### Web Interface
3636

37-
Running `penifycli config llm` opens a web interface in your browser where you can configure:
37+
Running `penify config llm` opens a web interface in your browser where you can configure:
3838

3939
1. **Model**: The LLM model to use (e.g., `gpt-3.5-turbo`)
4040
2. **API Base URL**: The endpoint URL for your LLM API (e.g., `https://api.openai.com/v1`)
@@ -82,7 +82,7 @@ After configuration, your `~/.penify/config.json` will contain:
8282

8383
### Web Interface
8484

85-
Running `penifycli config jira` opens a web interface where you can configure:
85+
Running `penify config jira` opens a web interface where you can configure:
8686

8787
1. **JIRA URL**: Your JIRA instance URL (e.g., `https://yourcompany.atlassian.net`)
8888
2. **Username**: Your JIRA username (typically your email)
@@ -133,7 +133,7 @@ You can override configuration settings using environment variables:
133133
Example:
134134
```bash
135135
export PENIFY_LLM_MODEL="gpt-4"
136-
penifycli commit
136+
penify commit
137137
```
138138

139139
## Command-Line Configuration

docs/file-documentation-cli.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Penify-CLI can generate comprehensive documentation for individual code files.
1717
Login to Penify, make sure you have an account or you have [created an account](https://www.penify.dev/).
1818

1919
```bash
20-
penifycli login
20+
penify login
2121
```
2222

2323
## Usage
2424

2525
To generate documentation for a single file:
2626

2727
```bash
28-
penifycli doc-gen -fl /path/to/your/file.py
28+
penify doc-gen -fl /path/to/your/file.py
2929
```
3030

3131
### Options
@@ -36,7 +36,7 @@ penifycli doc-gen -fl /path/to/your/file.py
3636
## Example
3737

3838
```bash
39-
penifycli doc-gen -fl /path/to/project/main.py
39+
penify doc-gen -fl /path/to/project/main.py
4040
```
4141

4242
## Output

docs/git-commit-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Use the following structure for your commit messages:
5555
Penify-CLI can help generate comprehensive commit messages:
5656

5757
```bash
58-
penifycli commit -gf /path/to/repo -t your_token
58+
penify commit -gf /path/to/repo -t your_token
5959
```
6060

6161
This command will analyze your changes and generate a commit message. You can then review and edit if necessary.
@@ -127,7 +127,7 @@ Fixes #456
127127
Penify-CLI can help analyze your commits and suggest improvements:
128128

129129
```bash
130-
penifycli analyze-commits -gf /path/to/repo -t your_token
130+
penify analyze-commits -gf /path/to/repo -t your_token
131131
```
132132

133133
This command will provide feedback on your recent commits and suggest ways to improve them.

docs/git-workflow-guide.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This guide outlines best practices for managing and documenting changes in your
2828
1. **Commit Often**: Make small, focused commits rather than large, multi-purpose ones.
2929
2. **Write Clear Commit Messages**: Use Penify-CLI's commit summary generation for consistency.
3030
```bash
31-
penifycli commit -gf /path/to/repo -t your_token
31+
penify commit -gf /path/to/repo -t your_token
3232
```
3333
3. **Use Conventional Commit Messages**: Follow a format like:
3434
```
@@ -45,7 +45,7 @@ This guide outlines best practices for managing and documenting changes in your
4545
1. Create a Pull Request (PR) for your feature branch.
4646
2. Use Penify-CLI to generate documentation for changed files:
4747
```bash
48-
penifycli doc-gen -t your_token -gf /path/to/repo
48+
penify doc-gen -t your_token -gf /path/to/repo
4949
```
5050
3. Include generated documentation in your PR description.
5151
4. Assign reviewers and address their comments.
@@ -57,15 +57,15 @@ This guide outlines best practices for managing and documenting changes in your
5757
2. **Keep README.md Current**: Update project overview and setup instructions as needed.
5858
3. **In-Code Documentation**: Use Penify-CLI to generate and update docstrings:
5959
```bash
60-
penifycli doc-gen -t your_token -fl /path/to/file.py
60+
penify doc-gen -t your_token -fl /path/to/file.py
6161
```
6262

6363
## 5. Release Process
6464

6565
1. Create a release branch from `develop`.
6666
2. Use Penify-CLI to generate full repository documentation:
6767
```bash
68-
penifycli doc-gen -t your_token -cf /path/to/repo
68+
penify doc-gen -t your_token -cf /path/to/repo
6969
```
7070
3. Update version numbers and CHANGELOG.md.
7171
4. Merge release branch to `main` and tag the release.

docs/instant-pull-request-insight.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ Penify's LLM implements self-reflection to improve result quality:
455455
### Command Line Interface
456456

457457
```bash
458-
penifycli pr insight --pr-number 123 --command review
458+
penify pr insight --pr-number 123 --command review
459459
```
460460

461461
### GitHub App / Webhook

docs/instant-pull-request-insigt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -441,7 +441,7 @@ Penify's AI implements self-reflection to improve result quality:
441441
### Command Line Interface
442442

443443
```bash
444-
penifycli pr insight --repo-path /path/to/repo --pr-number 123 --command review
444+
penify pr insight --repo-path /path/to/repo --pr-number 123 --command review
445445
```
446446

447447
### GitHub App / Webhook

0 commit comments

Comments
 (0)