xai-grok

Files (1)

• SKILL.md

SKILL.md (first lines)

# xAI Grok

Use this umbrella skill only for general plugin overview, setup orientation, or multi-tool xAI/Grok requests. For a specific tool request, prefer the dedicated skill:

- `xai_status`
- `xai_login_instructions`
- `xai_generate_text`
- `xai_web_search`
- `xai_x_search`
- `xai_image_generate`
- `xai_tts`
- `xai_video_generate`

## Tools

- `xai_status`: check whether OAuth or `XAI_API_KEY` credentials are available. Never expose token material.
- `xai_login_instructions`: show local setup commands and the auth-file path.
- `xai_generate_text`: generate text with Grok through xAI Responses.
- `xai_web_search`: answer with xAI server-side web search.
- `xai_x_search`: answer with xAI server-side X search. Do not pass both allowed and excluded handles.
- `xai_image_generate`: generate images with xAI `/images/generations`. Pass `artifact_dir` when the user wants local files; URL and `b64_json` images are saved there and returned in `artifacts`.
- `xai_tts`: generate speech audio.
- `xai_video_generate`: generate video.

## Credential Rules

- Prefer the shared xAI OIDC auth store at `~/.grok/auth.json`. It is a shared auth file, not a requirement to use a specific Grok CLI build.
- `CODEX_XAI_OAUTH_AUTH_FILE` overrides the auth-file path with a package-format OAuth file.
- `CODEX_XAI_OAUTH_GROK_AUTH_FILE` overrides the shared xAI OIDC auth-file path.
- Legacy package OAuth credentials at `~/.config/codex-xai-oauth/auth.json` are read only when the shared store is absent.
- `XAI_API_KEY` is the fallback credential.
- `XAI_BASE_URL` can override the API base URL.
- Do not print, quote, summarize, or store access tokens, refresh tokens, or API keys in chat.

## Setup

For OAuth device flow:

```bash
codex-xai-oauth login --device
```

For API-key fallback:

```bash
export XAI_API_KEY=xai-...
```

To check status:

```bash
codex-xai-oauth status
```

## Image Generation

Use `xai_image_generate` when the user asks to generate an image, Grok Imagine image, or xAI image. Defaults are `model: grok-imagine-image`, `response_format: url`, and `n: 1`.

Preferred MCP call:

```json
{
  "prompt": "tiny minimalist blue dot icon on white background",
  "resolution": "2k",
  "artifact_dir": ".codex-xai-artifacts"
}
```

Direct CLI equivalent:

```bash
codex-xai-oauth image \
  --prompt "tiny minimalist blue dot icon on white background" \
  --resolution 2k \
  --artifact-dir .codex-xai-artifacts
```

For base64 image payloads saved locally:

```bash
codex-xai-oauth image \
  --prompt "a cinematic robot reading a book" \
  --response-format b64_json \
  --artifact-dir .codex-xai-artifacts
```

Supported image options:

- `prompt`: required image prompt.
- `n`: number of images.
- `resolution`: `1k` or `2k`.
- `response_format`: `url` or `b64_json`.
- `size`: provider-specific size string.
- `artifact_dir`: local directory for saved image artifacts.

When `artifact_dir` is provided, return both the upstream JSON and the `artifacts` metadata. Each saved artifact includes a local `path`, `mime_type`, `source`, and `status`. If a remote URL cannot be downloaded, preserve the upstream `url` with `status: remote` instead of hiding it.

From islee23520/codex-xai-oauth, MIT.

More from islee23520/codex-xai-oauth