Editor Setup Guides

This directory contains guides for setting up various editors and IDEs to work effectively with Rhema (Git-Based Agent Context Protocol) projects.

Available Guides

Cursor Setup Guide

Complete guide for configuring Cursor to work with Rhema, including:

Installation and configuration
AI-powered workflows
Custom snippets and keyboard shortcuts
Best practices for context-aware development

VS Code Setup Guide

Comprehensive VS Code configuration for Rhema development:

Extension recommendations and configuration
Workspace settings and tasks
Git integration and debugging setup
AI assistance with GitHub Copilot

IntelliJ IDEA Setup Guide

Complete IntelliJ IDEA setup for Rhema development:

Plugin installation and configuration
External tools and run configurations
Live templates for Rhema files
Git integration and workflow automation

Vim/Neovim Setup Guide

Terminal-based editor setup for Rhema development:

Plugin management and configuration
Custom commands and functions
Git integration and hooks
Language server support

Sublime Text Setup Guide

Lightweight editor configuration for Rhema development:

Package installation and settings
Custom snippets and build systems
Git integration and key bindings
Workflow automation

Coming Soon

We plan to add setup guides for other editors:

Emacs - Extensible editor setup
Atom - GitHub’s editor (if still maintained)
Nano - Simple terminal editor

Contributing

If you’d like to contribute a setup guide for your preferred editor:

Create a new markdown file named [editor-name].md
Follow the structure of the existing guides
Include installation, configuration, and workflow sections
Add the guide to this README index
Submit a pull request

General Editor Setup Tips

Regardless of your editor choice, these general principles apply:

1. YAML Support

Ensure your editor has good YAML support for editing Rhema protocol files:

Syntax highlighting
Schema validation
Auto-completion
Format on save

2. Git Integration

Strong Git integration helps with Rhema workflows:

Visual diff tools
Branch management
Commit history
Merge conflict resolution

3. Terminal Integration

Easy access to terminal for running Rhema CLI commands:

Integrated terminal
Task runners
Custom commands
Keyboard shortcuts

4. AI Assistance

If your editor supports AI assistance:

Configure AI to understand Rhema context
Set up rules for context-aware suggestions
Enable AI to help maintain Rhema files

Common Configuration Files

Most editors can benefit from these configuration files:

`.cursorrules` (Cursor)


# Rhema Context Integration


This project uses Rhema for structured context management.
Reference .rhema/ files for existing knowledge and decisions.

`.vscode/settings.json` (VS Code)


{
  "yaml.schemas": {
    "schemas/rhema.json": ["**/rhema.yaml", "**/knowledge.yaml", "**/todos.yaml"]
  }
}

`.editorconfig` (Universal)


[*.{yaml,yml}]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true