grok-agent 0.5.0

package/CHANGELOG.md

@@ -0,0 +1,113 @@
+# Changelog
+
+All notable changes to grok-agent will be documented in this file.
+
+## [Unreleased]
+
+### Added
+
+- Typed server-side tool configuration for web search, X search, code execution, file search, and MCP.
+- Web search and X search filters: allowed/excluded domains, X handles, date ranges, and image/video understanding flags.
+- Collection-backed file search on the main chat path via `--collection` and `--file-search-mode`.
+- Expanded `collections` command set: `get`, `update`, `delete`, `docs`, `upload`, `rm-doc`, and `search`.
+- Batch API helpers: `batch create`, `list`, `status`, `requests`, `results`, `cancel`, `add-chat`, and `add-jsonl`.
+- Realtime API helper: `realtime secret`.
+- Session lifecycle commands: `archive`, `unarchive`, `rename`, `rollback`, and `compact`.
+- Review mode: `grok-agent review` for uncommitted diffs, base branches, and commits.
+- Sandbox modes and per-tool approval overrides.
+- TTS voice listing and streaming TTS support.
+- New unit coverage for server-tool serialization and approval policy behavior.
+
+### Changed
+
+- Responses API requests now serialize local function tools in xAI's native Responses format.
+- Session storage now tracks archived sessions and preserves pre-turn setup messages when rolling back turns.
+- Config loading now supports management API settings, MCP metadata, typed server tools, sandbox defaults, and tool approval overrides.
+- README and command help were updated to match the expanded CLI surface.
+
+## [0.4.0] - 2026-03-29
+
+### Added
+
+- **JSONL output mode** (`--json`): Machine-readable event streaming on stdout. Events: `session.started`, `turn.started`, `turn.completed`, `tool.called`, `tool.result`, `message`, `error`. Perfect for CI/automation pipelines.
+- **Ephemeral mode** (`--ephemeral`): Run without saving session to disk.
+- **Output file** (`-o, --output <file>`): Write final assistant message to a file.
+- **YOLO mode** (`--yolo`): Skip all approval prompts (for trusted environments).
+- **Color control** (`--color auto|always|never`): Override terminal color detection.
+- **Output truncation**: Tool outputs automatically truncated to prevent context window blowup. Preserves beginning and end, inserts omission notice.
+- **Context compaction**: When conversations exceed ~100k tokens, automatically summarizes older messages into a handoff brief and continues with fresh context.
+- **Fingerprint tracking**: Captures `system_fingerprint` from API responses (shown in verbose mode) for backend drift detection.
+- **Test suite**: 20 tests across tools (bash, read/write/edit, glob, grep, list_dir), sessions (create, load, update, delete, fork), and truncation. Uses Node.js native test runner.
+- **Proper exit codes**: Exit 1 on fatal errors for automation-friendly signaling.
+
+### Changed
+
+- Tool executor now applies output truncation before returning results.
+- Agent loop checks for context window limits and auto-compacts mid-session.
+- JSONL mode suppresses human-readable stdout output, keeping stderr for status.
+
+## [0.3.0] - 2026-03-29
+
+### Added
+
+- **`grok-agent models`**: List all available models from `/v1/models`. `models info <id>` for details.
+- **`grok-agent doctor`**: Diagnostics — validates API key, shows permissions, checks config and project context.
+- **`grok-agent config`**: Configuration management. `config --init` creates `~/.grok-agent/config.json` with defaults.
+- **`grok-agent tokenize`**: Count tokens via xAI's tokenizer API. Estimate costs before running.
+- **`grok-agent generate-video`** / **`video`**: Generate videos with `grok-imagine-video` (1-15s, multiple aspect ratios).
+- **`grok-agent speak`** / **`tts`**: Text-to-speech with 4 voices (eve, ara, sal, rex). Output to file or stdout.
+- **`grok-agent collections`**: Manage persistent document collections for RAG (list, create).
+- **Approval system**: `--approve` prompts before writes/exec. `--deny-writes` blocks them entirely. Approvals cached per session.
+- **Config file**: `~/.grok-agent/config.json` for persistent settings (model, approval policy, MCP servers, hooks, etc.).
+- **Project context files**: Automatically loads `GROK.md` or `.grokrc` from the project directory into the system prompt. Like CLAUDE.md for Grok.
+- **Diff display**: File edits show unified diffs with red/green coloring. Disable with `--no-diffs`.
+- **Prompt cache routing**: `x-grok-conv-id` header for sticky server routing — cached tokens cost 10x less.
+- **Plan mode**: `--plan` makes Grok create a step-by-step plan before executing.
+- **Session fork**: `--fork <id>` copies a session's history into a new session for branching exploration.
+- **Desktop notifications**: `--notify` triggers terminal notification (OSC9/BEL) when tasks complete.
+- **Hooks system**: Pre/post tool-use hooks configured in `config.json`. Run custom scripts on tool execution.
+- **Deferred completions**: `--defer` fires a request and returns a poll ID immediately (non-blocking).
+
+## [0.2.0] - 2026-03-29
+
+### Added
+
+- **Remote MCP tools**: `--mcp <url>` connects to any MCP server (DeepWiki, custom tools). xAI handles the connection server-side.
+- **Multi-agent research**: `--research` flag uses `grok-4.20-multi-agent` with 4-16 collaborating agents for deep research tasks.
+- **Image understanding**: `--image <path>` attaches images (screenshots, diagrams, errors) for Grok to analyze. Supports local files and URLs.
+- **Image generation**: `generate-image` / `imagine` subcommand creates images via `grok-imagine-image` and `grok-imagine-image-pro`.
+- **grok-code-fast-1**: `--code` flag selects the specialized coding model (4x faster, 1/10th cost, optimized for tool-heavy agentic work).
+- **File attachments**: `--attach <file>` uploads files (PDFs, docs, CSVs) to xAI for Grok to search and reference.
+- **Pipe mode**: `echo "prompt" | grok-agent` reads from stdin when piped. Combine with `cat`, `git diff`, etc.
+- **Token usage tracking**: `--show-usage` displays input/output/reasoning/cached token counts and estimated cost.
+- **Citation display**: Web search and X search results show source URLs. Disable with `--no-citations`.
+- **Structured outputs**: `--json-schema <schema>` forces Grok to return valid JSON matching the provided schema.
+- **Prompt cache optimization**: System prompt and tool definitions kept stable across turns to maximize xAI's automatic caching (cached tokens 10x cheaper).
+- **Dynamic system prompt**: System prompt now describes available capabilities (server-side tools, MCP servers, attached files/images).
+- **Interactive `/usage` command**: Check accumulated token usage during a REPL session.
+
+### Changed
+
+- Bumped version to 0.2.0.
+- Responses API is now auto-selected when any advanced feature is enabled (server-side tools, MCP, file attachments).
+- Agent loop supports both chat.completions (streaming, default) and Responses API (advanced features) with automatic fallback.
+
+## [0.1.0] - 2026-03-29
+
+### Added
+
+- Initial release of grok-agent.
+- **Exec mode**: run a prompt non-interactively (`grok-agent "prompt"`).
+- **Interactive REPL**: multi-turn conversations with `grok-agent`.
+- **Streaming**: real-time response output via SSE.
+- **7 local tools**: bash, read_file, write_file, edit_file, glob, grep, list_directory.
+- **Agent tool loop**: Grok autonomously calls tools, executes locally, feeds results back.
+- **Session persistence**: JSONL files in `~/.grok-agent/sessions/`.
+- **Session resume**: `-r <session-id>` to continue any previous session.
+- **Session management**: `sessions list`, `sessions show`, `sessions delete`, `sessions clear`.
+- **Model selection**: `--fast`, `--reasoning`, `--non-reasoning` flags.
+- **xAI Responses API**: stateful multi-turn with `previous_response_id`.
+- **xAI server-side tools**: `--web-search`, `--x-search`, `--code-execution`.
+- **Rate limit handling**: automatic retry with backoff on 429 errors.
+- **Global install**: `npm link` for system-wide `grok-agent` command.
+- **Windows support**: file:// URL handling for ESM on Windows.

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 baba20o
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.