You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
📝 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.
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.
11
11
.SH GLOBAL OPTIONS
12
12
.TP
13
13
.BR\-l ", "\-\-log
@@ -20,8 +20,20 @@ Display the version
20
20
.Bgen
21
21
Generate a commit message using AI
22
22
.TP
23
+
.Breview
24
+
Get an AI-powered code review for your staged changes
25
+
.TP
26
+
.Bchangelog
27
+
Generate a changelog between two Git references
28
+
.TP
29
+
.Brelease-notes
30
+
Generate comprehensive release notes
31
+
.TP
23
32
.Bconfig
24
-
Configure the AI-assisted Git commit message generator
33
+
Configure the AI-assisted Git workflow assistant
34
+
.TP
35
+
.Blist-presets
36
+
List available instruction presets
25
37
.SH "GEN COMMAND OPTIONS"
26
38
.TP
27
39
.BR\-a ", "\-\-auto-commit
@@ -33,8 +45,68 @@ Custom instructions for this commit
33
45
.BR\-\-provider =\fIPROVIDER\fR
34
46
Override default LLM provider
35
47
.TP
48
+
.BR\-\-preset =\fIPRESET\fR
49
+
Use a specific instruction preset
50
+
.TP
36
51
.BR\-\-no-gitmoji
37
52
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
38
110
.SH "CONFIG COMMAND OPTIONS"
39
111
.TP
40
112
.BR\-\-provider =\fIPROVIDER\fR
@@ -57,6 +129,38 @@ Enable or disable Gitmoji
57
129
.TP
58
130
.BR\-i ", "\-\-instructions =\fIINSTR\fR
59
131
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
+
.Banthropic
142
+
Claude AI models by Anthropic (API key required)
143
+
.TP
144
+
.Bdeepseek
145
+
DeepSeek AI models (API key required)
146
+
.TP
147
+
.Bgoogle
148
+
Gemini AI models by Google (API key required)
149
+
.TP
150
+
.Bgroq
151
+
Models hosted on Groq (API key required)
152
+
.TP
153
+
.Bollama
154
+
Local models via Ollama (no API key required)
155
+
.TP
156
+
.Bopenai
157
+
GPT models by OpenAI (API key required)
158
+
.TP
159
+
.Bphind
160
+
Phind AI models (API key required)
161
+
.TP
162
+
.Bxai
163
+
Grok models by xAI (API key required)
60
164
.SH EXAMPLES
61
165
Generate a commit message:
62
166
.PP
@@ -74,13 +178,69 @@ git-iris gen -i "Focus on performance improvements"
74
178
.RE
75
179
.fi
76
180
.PP
181
+
Generate a commit message using a specific preset:
0 commit comments