Skip to content

Commit 3a67fe9

Browse files
committed
📝 Update man page to reflect expanded tool capabilities
Update git-iris.1 man page with comprehensive documentation Expand the man page to accurately reflect git-iris's evolution from a simple commit message generator to a full Git workflow assistant: - Update tool description to highlight all major features - Document new commands: review, changelog, release-notes, list-presets - Add command options for all new functionality - Include information about supported LLM providers - Add examples for all major features and commands - Expand configuration options documentation This documentation update ensures users have complete reference information for all available features.
1 parent ff76709 commit 3a67fe9

File tree

1 file changed

+163
-3
lines changed

1 file changed

+163
-3
lines changed

git-iris.1

Lines changed: 163 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
.TH GIT-IRIS 1 "August 2024" "git-iris 0.1.0" "User Commands"
22
.SH NAME
3-
git-iris \- AI-assisted Git commit message generator
3+
git-iris \- AI-powered Git workflow assistant
44
.SH SYNOPSIS
55
.B git-iris
66
[\fIGLOBAL OPTIONS\fR]
77
\fICOMMAND \fR[\fICOMMAND OPTIONS\fR]
88
.SH DESCRIPTION
99
.B git-iris
10-
is an AI-powered tool designed to generate meaningful and context-aware Git commit messages. It analyzes your code changes and project context to provide high-quality commit messages that accurately describe your work.
10+
is a comprehensive AI-powered Git workflow assistant that enhances your development process. It offers intelligent support for crafting meaningful commit messages, generating changelogs, creating release notes, and providing code reviews. By leveraging advanced AI models, Git-Iris boosts your productivity and improves the quality of your project documentation.
1111
.SH GLOBAL OPTIONS
1212
.TP
1313
.BR \-l ", " \-\-log
@@ -20,8 +20,20 @@ Display the version
2020
.B gen
2121
Generate a commit message using AI
2222
.TP
23+
.B review
24+
Get an AI-powered code review for your staged changes
25+
.TP
26+
.B changelog
27+
Generate a changelog between two Git references
28+
.TP
29+
.B release-notes
30+
Generate comprehensive release notes
31+
.TP
2332
.B config
24-
Configure the AI-assisted Git commit message generator
33+
Configure the AI-assisted Git workflow assistant
34+
.TP
35+
.B list-presets
36+
List available instruction presets
2537
.SH "GEN COMMAND OPTIONS"
2638
.TP
2739
.BR \-a ", " \-\-auto-commit
@@ -33,8 +45,68 @@ Custom instructions for this commit
3345
.BR \-\-provider =\fIPROVIDER\fR
3446
Override default LLM provider
3547
.TP
48+
.BR \-\-preset =\fIPRESET\fR
49+
Use a specific instruction preset
50+
.TP
3651
.BR \-\-no-gitmoji
3752
Disable Gitmoji for this commit
53+
.TP
54+
.BR \-p ", " \-\-print
55+
Print the generated message to stdout and exit
56+
.TP
57+
.BR \-\-no-verify
58+
Skip verification steps (pre/post commit hooks)
59+
.SH "REVIEW COMMAND OPTIONS"
60+
.TP
61+
.BR \-i ", " \-\-instructions =\fIINSTR\fR
62+
Custom instructions for this review
63+
.TP
64+
.BR \-\-provider =\fIPROVIDER\fR
65+
Override default LLM provider
66+
.TP
67+
.BR \-\-preset =\fIPRESET\fR
68+
Use a specific instruction preset
69+
.TP
70+
.BR \-p ", " \-\-print
71+
Print the generated review to stdout and exit
72+
.SH "CHANGELOG COMMAND OPTIONS"
73+
.TP
74+
.BR \-\-from =\fIREF\fR
75+
Starting Git reference (commit hash, tag, or branch name)
76+
.TP
77+
.BR \-\-to =\fIREF\fR
78+
Ending Git reference (defaults to HEAD if not specified)
79+
.TP
80+
.BR \-i ", " \-\-instructions =\fIINSTR\fR
81+
Custom instructions for changelog generation
82+
.TP
83+
.BR \-\-preset =\fIPRESET\fR
84+
Select an instruction preset for changelog generation
85+
.TP
86+
.BR \-\-detail-level =\fILEVEL\fR
87+
Set the detail level (minimal, standard, detailed)
88+
.TP
89+
.BR \-\-gitmoji =\fIBOOL\fR
90+
Enable or disable Gitmoji in the changelog
91+
.SH "RELEASE-NOTES COMMAND OPTIONS"
92+
.TP
93+
.BR \-\-from =\fIREF\fR
94+
Starting Git reference (commit hash, tag, or branch name)
95+
.TP
96+
.BR \-\-to =\fIREF\fR
97+
Ending Git reference (defaults to HEAD if not specified)
98+
.TP
99+
.BR \-i ", " \-\-instructions =\fIINSTR\fR
100+
Custom instructions for release notes generation
101+
.TP
102+
.BR \-\-preset =\fIPRESET\fR
103+
Select an instruction preset for release notes generation
104+
.TP
105+
.BR \-\-detail-level =\fILEVEL\fR
106+
Set the detail level (minimal, standard, detailed)
107+
.TP
108+
.BR \-\-gitmoji =\fIBOOL\fR
109+
Enable or disable Gitmoji in the release notes
38110
.SH "CONFIG COMMAND OPTIONS"
39111
.TP
40112
.BR \-\-provider =\fIPROVIDER\fR
@@ -57,6 +129,38 @@ Enable or disable Gitmoji
57129
.TP
58130
.BR \-i ", " \-\-instructions =\fIINSTR\fR
59131
Set instructions for the commit message generation
132+
.TP
133+
.BR \-\-preset =\fIPRESET\fR
134+
Set default instruction preset
135+
.TP
136+
.BR \-\-default-provider =\fIPROVIDER\fR
137+
Set the default LLM provider
138+
.SH "SUPPORTED LLM PROVIDERS"
139+
Git-Iris supports multiple LLM providers:
140+
.TP
141+
.B anthropic
142+
Claude AI models by Anthropic (API key required)
143+
.TP
144+
.B deepseek
145+
DeepSeek AI models (API key required)
146+
.TP
147+
.B google
148+
Gemini AI models by Google (API key required)
149+
.TP
150+
.B groq
151+
Models hosted on Groq (API key required)
152+
.TP
153+
.B ollama
154+
Local models via Ollama (no API key required)
155+
.TP
156+
.B openai
157+
GPT models by OpenAI (API key required)
158+
.TP
159+
.B phind
160+
Phind AI models (API key required)
161+
.TP
162+
.B xai
163+
Grok models by xAI (API key required)
60164
.SH EXAMPLES
61165
Generate a commit message:
62166
.PP
@@ -74,13 +178,69 @@ git-iris gen -i "Focus on performance improvements"
74178
.RE
75179
.fi
76180
.PP
181+
Generate a commit message using a specific preset:
182+
.PP
183+
.nf
184+
.RS
185+
git-iris gen --preset conventional
186+
.RE
187+
.fi
188+
.PP
189+
Get an AI code review:
190+
.PP
191+
.nf
192+
.RS
193+
git-iris review
194+
.RE
195+
.fi
196+
.PP
197+
Generate a changelog between two versions:
198+
.PP
199+
.nf
200+
.RS
201+
git-iris changelog --from v1.0.0 --to v1.1.0
202+
.RE
203+
.fi
204+
.PP
205+
Generate release notes:
206+
.PP
207+
.nf
208+
.RS
209+
git-iris release-notes --from v1.0.0 --to v1.1.0 --preset conventional
210+
.RE
211+
.fi
212+
.PP
77213
Configure the OpenAI provider:
78214
.PP
79215
.nf
80216
.RS
81217
git-iris config --provider openai --api-key YOUR_API_KEY
82218
.RE
83219
.fi
220+
.PP
221+
Configure the Anthropic provider:
222+
.PP
223+
.nf
224+
.RS
225+
git-iris config --provider anthropic --api-key YOUR_API_KEY
226+
.RE
227+
.fi
228+
.PP
229+
Set a default preset:
230+
.PP
231+
.nf
232+
.RS
233+
git-iris config --preset conventional
234+
.RE
235+
.fi
236+
.PP
237+
List all available presets:
238+
.PP
239+
.nf
240+
.RS
241+
git-iris list-presets
242+
.RE
243+
.fi
84244
.SH FILES
85245
.TP
86246
.I ~/.config/git-iris/config.toml

0 commit comments

Comments
 (0)