pushai 0.1.3 → 0.1.6

package/README.md

@@ -1,38 +1,35 @@
 <p align="center">
-  <img src="../../apps/web/public/favicon.png" alt="PushAI favicon" width="64" height="64" />
+  <img src="https://pushai.vercel.app/logo.svg" alt="PushAI logo" width="64" height="64" />
 </p>
 
 <h1 align="center">PushAI</h1>
 
 <p align="center">
-  Stop writing commit messages.
+  <strong>Stop writing manual commit messages.</strong><br />
+  Let AI analyze your diffs, generate conventional commits, and push to remote – in one keystroke.
 </p>
 
 <p align="center">
-  <a href="https://github.com/thelastofinusa/pushai">Repository</a>
-  ·
-  <a href="./docs/technical-decisions.md">Technical decisions</a>
-  ·
-  <a href="./docs/publishing.md">Publishing</a>
+  <a href="https://www.npmjs.com/package/pushai"><img src="https://img.shields.io/npm/v/pushai.svg" alt="npm version" /></a>
+  <a href="https://github.com/thelastofinusa/pushai/blob/main/LICENSE"><img src="https://img.shields.io/github/license/thelastofinusa/pushai" alt="GitHub license" /></a>
+  <a href="https://www.npmjs.com/package/pushai"><img src="https://img.shields.io/npm/dt/pushai.svg" alt="npm downloads" /></a>
 </p>
 
-## pushai (pai)
-
-The only Git CLI you'll ever need. Stop wasting time thinking of commit messages. Let AI do it, then push in one click.
-
-[![npm version](https://img.shields.io/npm/v/pushai.svg)](https://www.npmjs.com/package/pushai)
-
 ### Features
 
-- **Multi-Provider:** Google Gemini, OpenAI, and HuggingFace support.
-- **Privacy First:** Support for Local LLMs (Ollama/LM Studio) via custom base URLs.
-- **Conventional Commits:** Automatically generates standard, readable messages.
-- **Auto-Push:** Stages, commits, and pushes to remote in one flow.
-- **Smart Init:** Automatically detects and offers to initialize git in new folders.
+- **Multi‑Provider** – Google Gemini, OpenAI, HuggingFace, and any OpenAI‑compatible local endpoint (Ollama, LM Studio).
+- **Privacy First** – Run completely locally by connecting to your own LLM instance.
+- **Conventional Commits** – Generates standardised, readable messages (`feat:`, `fix:`, `docs:`, etc.).
+- **Auto‑Push** – Stages all changes, commits with the generated message, and pushes to remote in one seamless flow.
+- **Smart Init** – Automatically detects missing Git repositories and offers to initialise them.
+- **Interactive Approval** – Review, edit, or regenerate the commit message before anything is pushed.
+- **Dry‑Run Mode** – Preview the generated message without committing or pushing.
+
+---
 
 ### Installation
 
-**Run instantly**
+**Run instantly (no global install)**
 
 ```bash
 npx pushai
@@ -53,45 +50,89 @@ pnpm add -g pushai
 # or
 yarn global add pushai
 # or
-bunx --bun pushai
+bun install -g pushai
 ```
 
-### Usage
+After global installation, you can use the shorthand `pai` (recommended).
 
-You can use the full command `pushai` or the shorthand `pai`.
+---
 
-**1. Initial Setup**
+### Quick Start
 
-The first time you run `pai`, it will guide you through configuring your AI provider and API key.
+1. **Configure your AI provider**
 
-```bash
-pai config
-```
+   ```bash
+   pai config
+   ```
 
-**2. The Main Workflow**
+   Follow the interactive wizard to select a provider (e.g., OpenAI, Gemini), enter your API key, and choose a model.
 
-Simply run `pai` when you have unstaged or modified changes.
+2. **Stage your changes and let AI do the rest**
 
-```bash
-pai
-# or
-pai commit
-```
+   ```bash
+   pai
+   ```
+
+   PushAI will:
+   - Stage all modified/untracked files.
+   - Generate a conventional commit message based on your diff.
+   - Show you the message and ask for confirmation.
+   - Commit and push (if you approve).
+
+---
 
 ### Commands
 
-| Command         | Description                                                    |
-| --------------- | -------------------------------------------------------------- |
-| `pai`           | Default action: stages changes, generates message, and pushes. |
-| `pai commit`    | Explicitly triggers the commit/push workflow.                  |
-| `pai config`    | Update your API key, provider, or model choice.                |
-| `pai reset`     | Deletes the entire `pushai` config directory.                  |
-| `pai --version` | Display current version.                                       |
-| `pai --help`    | Display help message.                                          |
-
-### Supported Providers
-
-- **Google Gemini:** `gemini-1.5-flash` (Fast & Free tier available).
-- **OpenAI:** `gpt-4o`, `gpt-4o-mini`.
-- **HuggingFace:** `Llama 3`, `Mistral`, etc.
-- **Local/Custom:** Anything OpenAI-compatible (Ollama, Groq).
+| Command                | Description                                                            |
+| ---------------------- | ---------------------------------------------------------------------- |
+| `pai commit`           | Stage, generate, approve, commit, and push.                            |
+| `pai commit --dry-run` | Generate a commit message and show it, but do not commit or push.      |
+| `pai config`           | Interactive setup: choose provider, model, and set API key / base URL. |
+| `pai reset`            | Deletes all local configuration and API keys from your system.         |
+| `pai --version` / `-v` | Display the installed version.                                         |
+| `pai --help` / `-h`    | Show help for all commands.                                            |
+
+---
+
+### Configuration
+
+PushAI stores your non‑secret settings in `~/.config/pushai/config.json` and your API key in the system keychain (macOS/Windows/Linux).
+
+You can manually edit the config file, but using `pai config` is recommended.
+
+Example `config.json`:
+
+```json
+{
+  "provider": "openai",
+  "model": "gpt-4o",
+  "baseUrl": "http://localhost:11434/v1" // optional, for local Ollama
+}
+```
+
+> **Note:** The API key is stored securely via `keytar` and never appears in the config file.
+
+---
+
+### How It Works
+
+1. **`pai` / `pai commit`**
+   - Checks if you are inside a Git repository.
+   - Stages all changes (`git add .`).
+   - Sends the diff to your chosen AI provider with a specialised prompt.
+   - Returns a conventional commit message (`feat(scope): description`).
+
+2. **Interactive approval**
+   - You see the generated message inside a box.
+   - Options: accept, edit, regenerate, or cancel.
+   - If you accept, the tool commits and pushes to the current remote branch.
+
+3. **Security**
+   - API keys are stored in the system keychain, not in plain text.
+   - Local endpoints (`baseUrl`) keep all data on your machine.
+
+---
+
+### License
+
+[MIT](./LICENSE) © Holiday

package/dist/index.mjs

@@ -47,4 +47,4 @@ ${a}
 Git reported an error: ${c.message}
 `)),process.exit(1)}}}catch(o){o.name==="ExitPromptError"&&(console.log(t.dim(`
 Exited by user request.
-`)),process.exit(0)),M(o),process.exit(1)}}var O="pushai",z="0.1.2",N="AI-powered CLI for effortless git commits and pushes";var p=new se;p.name(O).description(N).option("--dry-run","Generate commit message but do not commit or push").action(e=>I(e.dryRun));p.name(O).description(N).version(z,"-v, --version","output the version number");p.action(()=>I(!1));p.command("commit").description("Stage changes, generate a message, and push").option("--dry-run","Generate commit message but do not commit or push").action(e=>I(e.dryRun));p.command("config").description("Configure AI providers and API keys").action(C);p.command("reset").description("Delete the local config.json file").action(L);p.parse();
+`)),process.exit(0)),M(o),process.exit(1)}}var O="pushai",z="0.1.3",N="AI-powered CLI for effortless git commits and pushes";var p=new se;p.name(O).description(N).option("--dry-run","Generate commit message but do not commit or push").action(e=>I(e.dryRun));p.name(O).description(N).version(z,"-v, --version","output the version number");p.action(()=>I(!1));p.command("commit").description("Stage changes, generate a message, and push").option("--dry-run","Generate commit message but do not commit or push").action(e=>I(e.dryRun));p.command("config").description("Configure AI providers and API keys").action(C);p.command("reset").description("Delete the local config.json file").action(L);p.parse();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pushai",
-  "version": "0.1.3",
-  "description": "AI-powered CLI for effortless git commits and pushes",
+  "version": "0.1.6",
+  "description": "Stop writing manual commit messages.",
   "bin": {
     "pai": "./dist/index.mjs"
   },
@@ -12,6 +12,7 @@
     "pushout": "npm publish",
     "pushout-inc": "npm version patch --no-git-tag-version && pnpm pushout"
   },
+  "homepage": "https://pushai.vercel.app",
   "keywords": [
     "cli",
     "git",

package/.turbo/turbo-build.log

@@ -1,17 +0,0 @@
-
-
-> pushai@0.1.2 build /Users/holiday/Desktop/pushai/apps/cli
-> tsup src/index.ts --format esm --clean --minify
-
-CLI Building entry: src/index.ts
-CLI Using tsconfig: tsconfig.json
-CLI tsup v8.5.1
-CLI Using tsup config: /Users/holiday/Desktop/pushai/apps/cli/tsup.config.ts
-CLI Target: esnext
-CLI Cleaning output folder
-ESM Build start
-ESM dist/index.mjs 10.17 KB
-ESM ⚡️ Build success in 11ms
-DTS Build start
-DTS ⚡️ Build success in 912ms
-DTS dist/index.d.mts 13.00 B