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
> **GitAI CLI is your intelligent Git assistant, supercharging your workflow with AI-powered command generation. Craft perfect commit messages and pull request descriptions in seconds!**
gitai pr -t main # writes .gitai/pr_docs/<ts>-feature.md
52
58
```
53
59
60
+
> [!Tip]
61
+
>
62
+
> If you have permission issues, try:
63
+
>
64
+
> ```bash
65
+
># For macOS & Linux
66
+
> sudo npm i -g @lastwhisper-dev/gitai-cli
67
+
># For Windows, use PowerShell/CMD in admin mode
68
+
>```
69
+
>
70
+
> If you have network issues, try:
71
+
>
72
+
>```bash
73
+
> npm config set registry https://registry.npmmirror.com
74
+
>```
75
+
54
76
### Install from source
55
77
56
78
```bash
@@ -65,7 +87,7 @@ Now you can use `gitai` commands anywhere on your system.
65
87
66
88
1.**Set up API Keys (Environment Variables):**
67
89
68
-
GitAI CLI needs API keys for the LLM providers you intend to use. Create a `.env` file in your project root or set these globally in your shell environment. See `.env-example` for a template:
90
+
GitAI CLI needs API keys for the LLM providers you intend to use. Create a `.env` file in your project root or set these globally in your shell environment. See `.env-example` for a template (created by `gitai init`):
69
91
70
92
```env
71
93
OPENAI_API_KEY="Your OpenAI API Key"
@@ -131,7 +153,7 @@ Now you can use `gitai` commands anywhere on your system.
131
153
-**`gitai commit`**:
132
154
- Automatically generates commit messages based on your staged changes.
133
155
- Provides multiple suggestions for you to choose from.
134
-
- Adheres to Conventional Commits format by default.
156
+
- Adheres to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format by default.
135
157
- Allows custom prompts for tailored message styles.
136
158
-**`gitai pr`**:
137
159
- Generates comprehensive Pull Request titles and descriptions.
0 commit comments