grok-image-cli

# grok-image-cli

A CLI for generating and editing images using the xAI Grok API. Supports multiple models: `grok-imagine-image` (default), `grok-imagine-image-pro`, `grok-2-image-1212`. Powered by the official `@ai-sdk/xai` SDK. Credentials are stored in the OS native credential store (macOS Keychain, Windows Credential Manager, Linux Secret Service) via `cross-keychain`.

## Installation

Requires Node.js >= 20.19.0. Works on macOS, Windows, and Linux. The package is fully open source under the MIT license: https://github.com/cyberash-dev/grok-image-cli

```bash
npm install -g grok-image-cli
```

The npm package is published with provenance attestation, linking each release to its source commit via GitHub Actions. You can verify the published contents before installing:
```bash
npm pack grok-image-cli --dry-run
```

Install from source (if you prefer to audit the code before running):
```bash
git clone https://github.com/cyberash-dev/grok-image-cli.git
cd grok-image-cli
npm install && npm run build && npm link
```

After installation the `grok-img` command is available globally.

## Quick Start

```bash
grok-img auth login                                                      # Interactive prompt: enter xAI API key
grok-img generate "A futuristic city skyline at night"                   # Generate with default model
grok-img generate "A futuristic city skyline at night" -m grok-imagine-image-pro  # Use pro model
grok-img edit "Make it a watercolor painting" -i ./photo.jpg             # Edit an existing image
```

## API Key Management

Store API key (interactive prompt):
```bash
grok-img auth login
```

Show stored key (masked) and source:
```bash
grok-img auth status
```

Remove key from credential store:
```bash
grok-img auth logout
```

The CLI also supports the `XAI_API_KEY` environment variable as a fallback when no credential store entry is found.

## Image Generation

```bash
grok-img generate "A collage of London landmarks in street-art style"
grok-img gene...