pushai 1.0.2 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -26
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -16,15 +16,14 @@
|
|
|
16
16
|
|
|
17
17
|
### Features
|
|
18
18
|
|
|
19
|
-
- **Multi‑Provider** – Google Gemini, OpenAI,
|
|
20
|
-
- **Privacy First** – Run completely locally by connecting to your own LLM instance.
|
|
19
|
+
- **Multi‑Provider** – Google Gemini, OpenAI, and HuggingFace.
|
|
21
20
|
- **Conventional Commits** – Generates standardised, readable messages (`feat:`, `fix:`, `docs:`, etc.).
|
|
22
21
|
- **Auto‑Push** – Stages all changes, commits with the generated message, and pushes to remote in one seamless flow.
|
|
23
22
|
- **Smart Init** – Automatically detects missing Git repositories and offers to initialise them.
|
|
24
23
|
- **Interactive Approval** – Review, edit, or regenerate the commit message before anything is pushed.
|
|
25
24
|
- **Dry‑Run Mode** – Preview the generated message without committing or pushing.
|
|
26
|
-
|
|
27
|
-
|
|
25
|
+
- **Test Mode** – Verify your API key and provider configuration with `pai test`.
|
|
26
|
+
- **Progressive Timeouts** – Clear feedback when operations take longer than expected (10s, 60s).
|
|
28
27
|
|
|
29
28
|
### Installation
|
|
30
29
|
|
|
@@ -54,8 +53,6 @@ bun install -g pushai
|
|
|
54
53
|
|
|
55
54
|
After global installation, you can use the shorthand `pai` (recommended).
|
|
56
55
|
|
|
57
|
-
---
|
|
58
|
-
|
|
59
56
|
### Quick Start
|
|
60
57
|
|
|
61
58
|
1. **Configure your AI provider**
|
|
@@ -78,20 +75,16 @@ After global installation, you can use the shorthand `pai` (recommended).
|
|
|
78
75
|
- Show you the message and ask for confirmation.
|
|
79
76
|
- Commit and push (if you approve).
|
|
80
77
|
|
|
81
|
-
---
|
|
82
|
-
|
|
83
78
|
### Commands
|
|
84
79
|
|
|
85
|
-
| Command | Description
|
|
86
|
-
| ---------------------- |
|
|
87
|
-
| `pai commit` | Stage, generate, approve, commit, and push.
|
|
88
|
-
| `pai commit --dry-run` | Generate a commit message and show it, but do not commit or push.
|
|
89
|
-
| `pai config` | Interactive setup: choose provider, model, and set API key
|
|
90
|
-
| `pai reset` | Deletes all local configuration and API keys from your system.
|
|
91
|
-
| `pai --version` / `-v` | Display the installed version.
|
|
92
|
-
| `pai --help` / `-h` | Show help for all commands.
|
|
93
|
-
|
|
94
|
-
---
|
|
80
|
+
| Command | Description |
|
|
81
|
+
| ---------------------- | ----------------------------------------------------------------- |
|
|
82
|
+
| `pai commit` | Stage, generate, approve, commit, and push. |
|
|
83
|
+
| `pai commit --dry-run` | Generate a commit message and show it, but do not commit or push. |
|
|
84
|
+
| `pai config` | Interactive setup: choose provider, model, and set API key. |
|
|
85
|
+
| `pai reset` | Deletes all local configuration and API keys from your system. |
|
|
86
|
+
| `pai --version` / `-v` | Display the installed version. |
|
|
87
|
+
| `pai --help` / `-h` | Show help for all commands. |
|
|
95
88
|
|
|
96
89
|
### Configuration
|
|
97
90
|
|
|
@@ -104,28 +97,25 @@ Example `config.json`:
|
|
|
104
97
|
```json
|
|
105
98
|
{
|
|
106
99
|
"provider": "openai",
|
|
107
|
-
"model": "gpt-4o"
|
|
108
|
-
"baseUrl": "http://localhost:11434/v1" // optional, for local Ollama
|
|
100
|
+
"model": "gpt-4o"
|
|
109
101
|
}
|
|
110
102
|
```
|
|
111
103
|
|
|
112
104
|
> **Note:** The API key is stored securely via `keytar` and never appears in the config file.
|
|
113
105
|
|
|
114
|
-
---
|
|
115
|
-
|
|
116
106
|
### How It Works
|
|
117
107
|
|
|
118
108
|
1. **`pai` / `pai commit`**
|
|
119
109
|
- Checks if you are inside a Git repository.
|
|
120
|
-
- Stages all changes (`git add
|
|
110
|
+
- Stages all changes (`git add -A`).
|
|
121
111
|
- Sends the diff to your chosen AI provider with a specialised prompt.
|
|
122
112
|
- Returns a conventional commit message (`feat(scope): description`).
|
|
113
|
+
- If the operation takes longer than 10 seconds, you’ll see a friendly warning; after 60 seconds, a further alert appears.
|
|
123
114
|
|
|
124
115
|
2. **Interactive approval**
|
|
125
|
-
- You see the generated message inside a box.
|
|
116
|
+
- You see the generated message inside a clean note box.
|
|
126
117
|
- Options: accept, edit, regenerate, or cancel.
|
|
127
|
-
-
|
|
118
|
+
- The “regenerate” action asks for a **different** message (increased temperature + extra prompt instruction).
|
|
128
119
|
|
|
129
120
|
3. **Security**
|
|
130
121
|
- API keys are stored in the system keychain, not in plain text.
|
|
131
|
-
- Local endpoints (`baseUrl`) keep all data on your machine.
|