The open standard for Grok agents on X.
grok-install is a YAML manifest spec, a Python validator, and a GitHub Action
that turn any AI agent into a one-click install on X. One declarative
grok-install.yaml file describes the agent's runtime, prompts, tools, safety
profile, and X integration. The v2.14 schema is locked; eighteen ready-to-fork
templates cover everything from a daily brief bot to a multi-agent research
swarm.
-
Install the validator (v1.0.0 ships from GitHub; PyPI publish is deferred to v1.1+):
pip install "git+https://github.com/AgentMindCloud/grok-install@v1.0.0"Or download the wheel from the latest GitHub Release and
pip install ./grok_install-1.0.0-*.whl. -
Validate a manifest:
grok-install validate path/to/grok-install.yaml
-
Install the manifest on macOS, Linux, or Windows with the cross-platform runtime — see xlOS.
Eight production templates live under templates/core/:
AlphaSignalBot.yaml— daily market updates, technical-analysis replies, no financial advice.AskMe.yaml— Q&A bot for a topic of your choice.DailyBrief.yaml— morning summaries on a niche or topic.DevPilot.yaml— API answers and coding tips for developers.DogeDoughAI.yaml— friendly AI for restaurants and local brands.ShowNotes.yaml— podcast and livestream summaries with timestamps.VibeReply.yaml— light, tone-matched replies.VisualForge.yaml— daily AI art with watermarked output.
Ten community-curated examples live under templates/community/:
code-reviewer.yaml— reviews GitHub PRs with Grok reasoning.hello-grok.yaml— the simplest possible Grok agent.live-event-commentator.yaml— X commentary on a live event with rate limits and a kill switch.personal-knowledge.yaml— searchable memory of your X history.reply-engagement-bot.yaml— drafts replies to mentions behind an approval gate.research-swarm.yaml— researcher + critic + publisher swarm.scientific-discovery.yaml— daily arXiv brief and the X discussion around it.thread-ghostwriter.yaml— turns an idea into a polished X thread matched to your voice.trend-to-thread.yaml— monitors X trends and drafts a full thread.voice-agent-x.yaml— speak a post, review the transcript, approve, publish.
Validate the whole set with grok-install validate templates/.
The canonical manifest schema is spec/v2.14/schema.json —
JSON Schema 2020-12, locked at v2.14. Conformant parsers accept unknown
top-level keys and unknown extensions: sub-keys per the backward-compatibility
policy.
Fourteen sibling YAMLs under standards/ declare reusable agent
components: grok-agent, grok-workflow, grok-swarm, grok-tools,
grok-prompts, grok-voice, grok-security, grok-deploy, grok-config,
grok-test, grok-update, grok-docs, grok-analytics, grok-ui.
The Python CLI in this repo is the validator. For the cross-platform runtime
that actually installs grok-install.yaml manifests on macOS, Linux, and
Windows, see xlOS.
Validate .grok/ agents in CI with the in-tree GitHub Action at
action/. Composite action, Node 20, generates a Grok-Native
Certified SVG badge on main pushes. See action/README.md
for inputs, outputs, and a copy-paste workflow example.
Syntax highlighting, language configuration, and snippets for the
grok-install.yaml family live at extensions/vscode/.
Marketplace publishing wires up in a later phase; the extension is loadable
from source today.
A full documentation site (built from docs/ with mkdocs-material)
deploys via GitHub Pages. The URL is announced at the v1.0.0 release.
See CONTRIBUTING.md. Community templates land via PR with a
passing grok-install validate check and a one-line description.