rhachet-brains-xai 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Uladzimir Kasacheuski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/contract/sdk/index.d.ts

@@ -0,0 +1,7 @@
+import type { BrainAtom } from 'rhachet';
+/**
+ * .what = returns all brain atoms provided by xai
+ * .why = enables consumers to register xai atoms with genContextBrain
+ */
+export declare const getBrainAtomsByXAI: () => BrainAtom[];
+export { genBrainAtom } from '../../domain.operations/atom/genBrainAtom';

package/dist/contract/sdk/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genBrainAtom = exports.getBrainAtomsByXAI = void 0;
+const genBrainAtom_1 = require("../../domain.operations/atom/genBrainAtom");
+/**
+ * .what = returns all brain atoms provided by xai
+ * .why = enables consumers to register xai atoms with genContextBrain
+ */
+const getBrainAtomsByXAI = () => {
+    return [
+        (0, genBrainAtom_1.genBrainAtom)({ slug: 'xai/grok-code-fast-1' }),
+        (0, genBrainAtom_1.genBrainAtom)({ slug: 'xai/grok-3' }),
+        (0, genBrainAtom_1.genBrainAtom)({ slug: 'xai/grok-3-mini' }),
+        (0, genBrainAtom_1.genBrainAtom)({ slug: 'xai/grok-4' }),
+        (0, genBrainAtom_1.genBrainAtom)({ slug: 'xai/grok-4-fast' }),
+    ];
+};
+exports.getBrainAtomsByXAI = getBrainAtomsByXAI;
+// re-export factory for direct access
+var genBrainAtom_2 = require("../../domain.operations/atom/genBrainAtom");
+Object.defineProperty(exports, "genBrainAtom", { enumerable: true, get: function () { return genBrainAtom_2.genBrainAtom; } });
+//# sourceMappingURL=index.js.map

package/dist/contract/sdk/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/contract/sdk/index.ts"],"names":[],"mappings":";;;AAEA,4EAAyE;AAEzE;;;GAGG;AACI,MAAM,kBAAkB,GAAG,GAAgB,EAAE;IAClD,OAAO;QACL,IAAA,2BAAY,EAAC,EAAE,IAAI,EAAE,sBAAsB,EAAE,CAAC;QAC9C,IAAA,2BAAY,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QACpC,IAAA,2BAAY,EAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;QACzC,IAAA,2BAAY,EAAC,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QACpC,IAAA,2BAAY,EAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE,CAAC;KAC1C,CAAC;AACJ,CAAC,CAAC;AARW,QAAA,kBAAkB,sBAQ7B;AAEF,sCAAsC;AACtC,0EAAyE;AAAhE,4GAAA,YAAY,OAAA"}

package/dist/domain.operations/atom/genBrainAtom.d.ts

@@ -0,0 +1,20 @@
+import { BrainAtom } from 'rhachet';
+/**
+ * .what = supported xai atom slugs
+ * .why = enables type-safe slug specification with model variants
+ */
+export type XAIAtomSlug = 'xai/grok-code-fast-1' | 'xai/grok-3' | 'xai/grok-3-mini' | 'xai/grok-4' | 'xai/grok-4-fast';
+/**
+ * .what = factory to generate xai brain atom instances
+ * .why = enables model variant selection via slug
+ *
+ * .note = xai api is openai-compatible with baseURL override
+ *
+ * .example
+ *   genBrainAtom({ slug: 'xai/grok-code-fast-1' })
+ *   genBrainAtom({ slug: 'xai/grok-3-mini' }) // fast + cheap
+ *   genBrainAtom({ slug: 'xai/grok-4' }) // advanced reasoning
+ */
+export declare const genBrainAtom: (input: {
+    slug: XAIAtomSlug;
+}) => BrainAtom;

package/dist/domain.operations/atom/genBrainAtom.js

@@ -0,0 +1,103 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genBrainAtom = void 0;
+const openai_1 = __importDefault(require("openai"));
+const zod_1 = require("zod");
+const rhachet_1 = require("rhachet");
+/**
+ * .what = model configuration by slug
+ * .why = maps slugs to API model names, descriptions, and context sizes
+ */
+const CONFIG_BY_SLUG = {
+    'xai/grok-code-fast-1': {
+        model: 'grok-code-fast-1',
+        description: 'grok-code-fast-1 - optimized for agentic coding (256K)',
+        context: 256000,
+    },
+    'xai/grok-3': {
+        model: 'grok-3-beta',
+        description: 'grok-3 - balanced reasoning (131K)',
+        context: 131000,
+    },
+    'xai/grok-3-mini': {
+        model: 'grok-3-mini-beta',
+        description: 'grok-3-mini - fast and cost-effective (131K)',
+        context: 131000,
+    },
+    'xai/grok-4': {
+        model: 'grok-4-07-09',
+        description: 'grok-4 - advanced reasoning (256K)',
+        context: 256000,
+    },
+    'xai/grok-4-fast': {
+        model: 'grok-4-fast-reasoning',
+        description: 'grok-4-fast - frontier with reasoning (2M)',
+        context: 2000000,
+    },
+};
+/**
+ * .what = factory to generate xai brain atom instances
+ * .why = enables model variant selection via slug
+ *
+ * .note = xai api is openai-compatible with baseURL override
+ *
+ * .example
+ *   genBrainAtom({ slug: 'xai/grok-code-fast-1' })
+ *   genBrainAtom({ slug: 'xai/grok-3-mini' }) // fast + cheap
+ *   genBrainAtom({ slug: 'xai/grok-4' }) // advanced reasoning
+ */
+const genBrainAtom = (input) => {
+    const config = CONFIG_BY_SLUG[input.slug];
+    return new rhachet_1.BrainAtom({
+        repo: 'xai',
+        slug: input.slug,
+        description: config.description,
+        /**
+         * .what = stateless inference (no tool use)
+         * .why = provides direct model access for reasoning tasks
+         */
+        ask: async (askInput, context) => {
+            // compose system prompt from briefs
+            const systemPrompt = askInput.role.briefs
+                ? await (0, rhachet_1.castBriefsToPrompt)({ briefs: askInput.role.briefs })
+                : undefined;
+            // get openai client from context or create new one with xai baseURL
+            const openai = context?.openai ??
+                new openai_1.default({
+                    apiKey: process.env.XAI_API_KEY,
+                    baseURL: 'https://api.x.ai/v1',
+                });
+            // build messages array
+            const messages = [];
+            if (systemPrompt) {
+                messages.push({ role: 'system', content: systemPrompt });
+            }
+            messages.push({ role: 'user', content: askInput.prompt });
+            // convert zod schema to json schema for structured output
+            const jsonSchema = zod_1.z.toJSONSchema(askInput.schema.output);
+            // call xai api with strict json_schema response format
+            const response = await openai.chat.completions.create({
+                model: config.model,
+                messages,
+                response_format: {
+                    type: 'json_schema',
+                    json_schema: {
+                        name: 'response',
+                        strict: true,
+                        schema: jsonSchema,
+                    },
+                },
+            });
+            // extract content from response
+            const content = response.choices[0]?.message?.content ?? '';
+            // parse JSON response and validate via schema
+            const parsed = JSON.parse(content);
+            return askInput.schema.output.parse(parsed);
+        },
+    });
+};
+exports.genBrainAtom = genBrainAtom;
+//# sourceMappingURL=genBrainAtom.js.map

package/dist/domain.operations/atom/genBrainAtom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genBrainAtom.js","sourceRoot":"","sources":["../../../src/domain.operations/atom/genBrainAtom.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA4B;AAI5B,6BAAwB;AAExB,qCAAwD;AAaxD;;;GAGG;AACH,MAAM,cAAc,GAGhB;IACF,sBAAsB,EAAE;QACtB,KAAK,EAAE,kBAAkB;QACzB,WAAW,EAAE,wDAAwD;QACrE,OAAO,EAAE,MAAO;KACjB;IACD,YAAY,EAAE;QACZ,KAAK,EAAE,aAAa;QACpB,WAAW,EAAE,oCAAoC;QACjD,OAAO,EAAE,MAAO;KACjB;IACD,iBAAiB,EAAE;QACjB,KAAK,EAAE,kBAAkB;QACzB,WAAW,EAAE,8CAA8C;QAC3D,OAAO,EAAE,MAAO;KACjB;IACD,YAAY,EAAE;QACZ,KAAK,EAAE,cAAc;QACrB,WAAW,EAAE,oCAAoC;QACjD,OAAO,EAAE,MAAO;KACjB;IACD,iBAAiB,EAAE;QACjB,KAAK,EAAE,uBAAuB;QAC9B,WAAW,EAAE,4CAA4C;QACzD,OAAO,EAAE,OAAS;KACnB;CACF,CAAC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,YAAY,GAAG,CAAC,KAA4B,EAAa,EAAE;IACtE,MAAM,MAAM,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE1C,OAAO,IAAI,mBAAS,CAAC;QACnB,IAAI,EAAE,KAAK;QACX,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,WAAW,EAAE,MAAM,CAAC,WAAW;QAE/B;;;WAGG;QACH,GAAG,EAAE,KAAK,EACR,QAIC,EACD,OAAe,EACG,EAAE;YACpB,oCAAoC;YACpC,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM;gBACvC,CAAC,CAAC,MAAM,IAAA,4BAAkB,EAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC5D,CAAC,CAAC,SAAS,CAAC;YAEd,oEAAoE;YACpE,MAAM,MAAM,GACT,OAAO,EAAE,MAA6B;gBACvC,IAAI,gBAAM,CAAC;oBACT,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW;oBAC/B,OAAO,EAAE,qBAAqB;iBAC/B,CAAC,CAAC;YAEL,uBAAuB;YACvB,MAAM,QAAQ,GAAwC,EAAE,CAAC;YACzD,IAAI,YAAY,EAAE,CAAC;gBACjB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;YAC3D,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAE1D,0DAA0D;YAC1D,MAAM,UAAU,GAAG,OAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YAE1D,uDAAuD;YACvD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC;gBACpD,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,QAAQ;gBACR,eAAe,EAAE;oBACf,IAAI,EAAE,aAAa;oBACnB,WAAW,EAAE;wBACX,IAAI,EAAE,UAAU;wBAChB,MAAM,EAAE,IAAI;wBACZ,MAAM,EAAE,UAAU;qBACnB;iBACF;aACF,CAAC,CAAC;YAEH,gCAAgC;YAChC,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,OAAO,IAAI,EAAE,CAAC;YAE5D,8CAA8C;YAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,OAAO,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC9C,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AAjEW,QAAA,YAAY,gBAiEvB"}

package/dist/infra/schema/asJsonSchema.d.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod';
+/**
+ * .what = convert a zod schema to JSON schema for native SDK enforcement
+ * .why = enables native structured output support in SDKs, reducing
+ *   token waste on validation retries
+ *
+ * .note = different SDKs require different conversion options:
+ *   - claude-agent-sdk: { $refStrategy: 'root' }
+ *   - codex-sdk: { target: 'openAi' }
+ */
+export declare const asJsonSchema: (input: {
+    schema: z.ZodSchema;
+}) => object;

package/dist/infra/schema/asJsonSchema.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.asJsonSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * .what = convert a zod schema to JSON schema for native SDK enforcement
+ * .why = enables native structured output support in SDKs, reducing
+ *   token waste on validation retries
+ *
+ * .note = different SDKs require different conversion options:
+ *   - claude-agent-sdk: { $refStrategy: 'root' }
+ *   - codex-sdk: { target: 'openAi' }
+ */
+const asJsonSchema = (input) => {
+    return zod_1.z.toJSONSchema(input.schema, { target: 'openAi' });
+};
+exports.asJsonSchema = asJsonSchema;
+//# sourceMappingURL=asJsonSchema.js.map

package/dist/infra/schema/asJsonSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asJsonSchema.js","sourceRoot":"","sources":["../../../src/infra/schema/asJsonSchema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;;;;;;;GAQG;AACI,MAAM,YAAY,GAAG,CAAC,KAA8B,EAAU,EAAE;IACrE,OAAO,OAAC,CAAC,YAAY,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC5D,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB"}

package/license.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 ehmpathy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -0,0 +1,103 @@
+{
+  "name": "rhachet-brains-xai",
+  "author": "ehmpathy",
+  "description": "rhachet brain.atom adapter for xai grok models",
+  "version": "0.0.0",
+  "repository": "ehmpathy/rhachet-brains-xai",
+  "homepage": "https://github.com/ehmpathy/rhachet-brains-xai",
+  "keywords": [
+    "rhachet",
+    "brain",
+    "xai",
+    "grok",
+    "llm",
+    "ai"
+  ],
+  "bugs": "https://github.com/ehmpathy/rhachet-brains-xai/issues",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "engines": {
+    "node": ">=8.0.0"
+  },
+  "files": [
+    "/dist"
+  ],
+  "dependencies": {
+    "@openai/codex-sdk": "0.77.0",
+    "domain-objects": "0.31.9",
+    "helpful-errors": "1.5.3",
+    "openai": "5.8.2",
+    "rhachet-artifact": "1.0.1",
+    "rhachet-artifact-git": "1.1.5",
+    "type-fns": "1.21.0",
+    "wrapper-fns": "1.1.7",
+    "zod": "4.3.4"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.3.8",
+    "@commitlint/cli": "19.5.0",
+    "@commitlint/config-conventional": "19.5.0",
+    "@swc/core": "1.15.3",
+    "@swc/jest": "0.2.39",
+    "@tsconfig/node20": "20.1.5",
+    "@tsconfig/strictest": "2.0.5",
+    "@types/jest": "30.0.0",
+    "@types/node": "22.15.21",
+    "cz-conventional-changelog": "3.3.0",
+    "declapract": "0.13.14",
+    "declapract-typescript-ehmpathy": "0.47.16",
+    "declastruct": "1.7.3",
+    "declastruct-github": "1.3.0",
+    "depcheck": "1.4.3",
+    "esbuild-register": "3.6.0",
+    "husky": "8.0.3",
+    "jest": "30.2.0",
+    "rhachet": "1.21.4",
+    "rhachet-roles-bhrain": "0.5.9",
+    "rhachet-roles-bhuild": "0.6.3",
+    "rhachet-roles-ehmpathy": "1.17.15",
+    "test-fns": "1.5.0",
+    "tsc-alias": "1.8.10",
+    "tsx": "4.20.6",
+    "typescript": "5.4.5",
+    "yalc": "1.0.0-pre.53"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "scripts": {
+    "build:ts": "tsc -p ./tsconfig.build.json",
+    "commit:with-cli": "npx cz",
+    "fix:format:biome": "biome check --write",
+    "fix:format": "npm run fix:format:biome",
+    "fix:lint": "biome check --write",
+    "fix": "npm run fix:format && npm run fix:lint",
+    "build:clean:bun": "rm -f ./bin/*.bc",
+    "build:clean:tsc": "(chmod -R u+w dist 2>/dev/null || true) && rm -rf dist/",
+    "build:clean": "npm run build:clean:tsc && npm run build:clean:bun",
+    "build:compile:tsc": "tsc -p ./tsconfig.build.json && tsc-alias -p ./tsconfig.build.json",
+    "build:compile": "npm run build:compile:tsc && npm run build:compile:bun --if-present",
+    "build": "npm run build:clean && npm run build:compile && npm run build:complete --if-present",
+    "test:commits": "LAST_TAG=$(git describe --tags --abbrev=0 @^ 2> /dev/null || git rev-list --max-parents=0 HEAD) && npx commitlint --from $LAST_TAG --to HEAD --verbose",
+    "test:types": "tsc -p ./tsconfig.json --noEmit",
+    "test:format:biome": "biome format",
+    "test:format": "npm run test:format:biome",
+    "test:lint:deps": "npx depcheck -c ./.depcheckrc.yml",
+    "test:lint:biome": "biome check --diagnostic-level=error",
+    "test:lint:biome:all": "biome check",
+    "test:lint": "npm run test:lint:biome && npm run test:lint:deps",
+    "test:unit": "jest -c ./jest.unit.config.ts --forceExit --verbose --passWithNoTests $([ -z $THOROUGH ] && echo '--changedSince=main') $([ -n $RESNAP ] && echo '--updateSnapshot')",
+    "test:integration": "jest -c ./jest.integration.config.ts --forceExit --verbose --passWithNoTests $([ -z $THOROUGH ] && echo '--changedSince=main') $([ -n $RESNAP ] && echo '--updateSnapshot')",
+    "test:acceptance:locally": "npm run build && LOCALLY=true jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests $([ -n $RESNAP ] && echo '--updateSnapshot')",
+    "test": "npm run test:commits && npm run test:types && npm run test:format && npm run test:lint && npm run test:unit && npm run test:integration && npm run test:acceptance:locally",
+    "test:acceptance": "npm run build && jest -c ./jest.acceptance.config.ts --forceExit --verbose --runInBand --passWithNoTests $([ -n $RESNAP ] && echo '--updateSnapshot')",
+    "prepush": "npm run test && npm run build",
+    "prepublish": "npm run build",
+    "preversion": "npm run prepush",
+    "postversion": "git push origin HEAD --tags --no-verify",
+    "prepare:husky": "husky install && chmod ug+x .husky/*",
+    "prepare:rhachet": "rhachet init --mode upsert && rhachet roles link --repo ehmpathy --role mechanic && rhachet roles link --repo bhuild --role behaver && rhachet roles link --repo bhrain --role reviewer && rhachet roles init --role mechanic && rhachet roles init --role behaver"
+  }
+}

package/readme.md

@@ -0,0 +1,57 @@
+# rhachet-brains-xai
+
+rhachet brain.atom adapter for xai grok models
+
+## install
+
+```sh
+npm install rhachet-brains-xai
+```
+
+## usage
+
+```ts
+import { genBrainAtom } from 'rhachet-brains-xai';
+import { z } from 'zod';
+
+// create a brain atom for direct model inference
+const brainAtom = genBrainAtom({ slug: 'xai/grok-code-fast-1' });
+
+// simple string output
+const response = await brainAtom.ask({
+  role: { briefs: [] },
+  prompt: 'explain this code',
+  schema: { output: z.string() },
+});
+
+// structured object output
+const result = await brainAtom.ask({
+  role: { briefs: [] },
+  prompt: 'analyze this code',
+  schema: { output: z.object({ summary: z.string(), issues: z.array(z.string()) }) },
+});
+```
+
+## available brains
+
+### atoms (via genBrainAtom)
+
+stateless inference without tool use.
+
+| slug                   | model                  | context | description                        |
+| ---------------------- | ---------------------- | ------- | ---------------------------------- |
+| `xai/grok-code-fast-1` | grok-code-fast-1       | 256K    | optimized for agentic code tasks   |
+| `xai/grok-3`           | grok-3-beta            | 131K    | balanced logic model               |
+| `xai/grok-3-mini`      | grok-3-mini-beta       | 131K    | fast and cost-effective            |
+| `xai/grok-4`           | grok-4-07-09           | 256K    | advanced logic model               |
+| `xai/grok-4-fast`      | grok-4-fast-reasoning  | 2M      | frontier model with tool use       |
+
+## environment
+
+requires `XAI_API_KEY` environment variable.
+
+## sources
+
+- [xAI API Documentation](https://docs.x.ai/docs/overview)
+- [xAI Models](https://docs.x.ai/docs/models)
+- [Grok Code Fast 1](https://x.ai/news/grok-code-fast-1)