Developer Resources
Welcome to the Grok One-Shot developer hub. Here you'll find everything you need to build with, extend, and contribute to Grok One-Shot.
Quick Links
🛠️ Development Setup
- Development Setup - Get your local development environment ready
- Contributing Guide - How to contribute to Grok One-Shot
- Architecture Overview - Understand how Grok One-Shot works
🔧 Building with Grok One-Shot
- MCP Integration - Connect external tools and services
- Hooks System - Automate workflows with hooks
- Configuration - Advanced configuration options
📖 API Reference
- CLI Reference - Complete command-line interface
- Environment Variables - Configuration via environment
- Settings Schema - JSON configuration format
Development Workflow
Local Development
-
Clone the repository
git clone https://github.com/x-cli-team/grok-one-shot.git
cd grok-one-shot -
Install dependencies
bun install -
Run in development mode
bun run dev
Contributing Code
- Follow the Contributing Guide
- Check the Development Setup for detailed instructions
- Review Architecture to understand the codebase
Testing
- Run tests:
bun test - Build locally:
bun run build - Check types:
bun run typecheck
Extension Points
MCP Servers
Extend Grok One-Shot capabilities by creating Model Context Protocol servers:
- File system tools
- API integrations
- Database connections
- Custom business logic
Configuration
Customize behavior through:
- User settings (
~/.grok/settings.json) - Project settings (
.grok/settings.json) - Environment variables
- Command-line flags
Resources
Documentation
- Getting Started - User guide
- Features - Detailed feature documentation
- Configuration - Setup and customization
Community
- Discord Community - Chat with developers
- GitHub Issues - Report bugs and request features
- Discussions - General discussions
Support
Need help with development?
- Check our Troubleshooting Guide
- Ask in Discord #developers
- Create a GitHub Discussion