Watch

grokkybara[bot] c68e39f604 Publish harness and TUI open-source

initial sync from the monorepo

2026-07-16 06:46:02 +01:00

5 KiB

Raw Blame History

Hooks & Plugins Guide

Grok Build supports hooks (event-driven shell commands) and plugins (bundles of skills, agents, hooks, and MCP servers). Both are managed through a unified modal interface.

Method	Opens on tab
`Ctrl+L`	Plugins (any pane; non–VS Code family — on VS Code / Cursor / Windsurf / Zed use `/plugins`)
`/plugins`	Plugins (any terminal)
`/hooks`	Hooks

Tabs

The modal has three tabs: Hooks, Plugins, and Marketplace. Switch between them with Tab / → (forward) or Shift+Tab / ← (backward).

Hooks Tab

Hooks are shell commands (or HTTP calls) that run automatically on events like session_start, post_tool_use, notification, etc. See Creating Custom Hooks for how to write your own.

Hooks are grouped by source:

Global hooks — from ~/.grok/hooks/
Project hooks — from .grok/hooks/ in your repo
Plugin hooks — bundled with installed plugins
Custom hooks — added manually via a path

Each hook shows:

Event it triggers on (e.g., session_start, post_tool_use)
Command or URL that runs
Timeout duration
Status — enabled or [disabled]

Shortcuts (Hooks tab)

Key	Action
`l`	Reload all hooks
`a`	Add hook from path
`r`	Remove selected hook
`e`	Enable / disable selected hook
`Space`	Expand / collapse group

Plugins Tab

Plugins are directories containing any combination of skills, agents, hooks, and MCP server configs.

Each plugin shows (when expanded):

Name and version
Scope — user, project, cli, or marketplace source name
Skills — names or count
Agents — names or count
Hooks — count
MCP servers — count (or "blocked" if not trusted)
Description
Conflicts — ⚠ warning if any

Plugin hooks automatically receive GROK_PLUGIN_ROOT and GROK_PLUGIN_DATA environment variables (see the Plugins guide).

Shortcuts (Plugins tab)

Key	Action
`r`	Reload all plugins
`i`	Install plugin from path
`e`	Enable / disable selected plugin
`Space`	Expand / collapse plugin details
`/`	Search plugins by name

Marketplace Tab

Browse and install plugins from configured marketplace sources.

Sources are loaded from:

config.toml — [[marketplace.sources]] entries
settings.json — extraKnownMarketplaces from ~/.grok/settings.json or ~/.claude/settings.json

Each source shows its plugins with:

Name and version
Description
Install status — [installed], [installed • update: v1 → v2], or not installed

Shortcuts (Marketplace tab)

Key	Action
`i`	Install selected plugin
`d`	Uninstall selected plugin
`r`	Refresh marketplace sources (re-clone/pull git repos)
`u`	Update all installed marketplace plugins
`Space`	Expand / collapse source or plugin
`/`	Search plugins by name

Adding Marketplace Sources

Press a on the Marketplace tab (or run grok plugin marketplace add <source>) with a git URL, a GitHub shorthand (owner/repo), or a local directory path (/absolute, ~/dir, or ./relative). Local paths are stored as path sources — handy for developing a marketplace from an existing checkout.

Sources land in ~/.grok/config.toml:

[[marketplace.sources]]
name = "My Team Plugins"
git = "https://github.com/my-org/plugins.git"

[[marketplace.sources]]
name = "Local Dev"
path = "~/dev/my-plugins"

Or in ~/.grok/settings.json / ~/.claude/settings.json:

{
  "extraKnownMarketplaces": {
    "my-marketplace": {
      "source": { "source": "git", "url": "git@github.com:my-org/plugins.git" },
      "autoUpdate": true
    }
  }
}

General Keyboard Shortcuts

These work across all tabs:

Key	Action
`Tab` / `→`	Next tab
`Shift+Tab` / `←`	Previous tab
`j` / `↓`	Move selection down
`k` / `↑`	Move selection up
`Space`	Toggle expand / collapse
`/`	Start search (Plugins & Marketplace)
`Backspace`	Delete search char, or re-enter search
`Esc`	Clear search, or close modal
`q`	Close modal

Confirmation & Errors

Some actions (like uninstalling a plugin) may ask for confirmation:

Press y to confirm
Press Esc or any other key to cancel

Errors are shown as a message overlay — press any key to dismiss.

While an action is in progress, the modal shows "Processing..." and blocks input until the operation completes.

5 KiB Raw Blame History Unescape Escape