Complete Getting Started Guide

# Clone the repository
git clone https://github.com/fugue-ai/rhema.git
cd rhema
 
# Build and install
cargo build --release
cargo install --path .

# Install directly from crates.io (when available)
cargo install rhema

# macOS (using Homebrew)
brew install rhema
 
# Linux (using package manager)
# Check your distribution's package repository

# Check Rhema version
rhema --version
 
# Check available commands
rhema --help

# Create a new directory for your project
mkdir my-rhema-project
cd my-rhema-project
 
# Initialize Rhema in the project
rhema init

my-rhema-project/
├── .rhema/
│   ├── config.yaml
│   ├── scope.yaml
│   └── lock.yaml
├── src/
├── tests/
└── README.md

name: my-rhema-project
description: My first Rhema project
version: "1.0.0"
author: "Your Name <your.email@example.com>"
 
# Define your project scope
scope:
  type: application
  language: rust
  framework: none
  
# Set up context patterns
context:
  files:
    - "src/**/*.rs"
    - "tests/**/*.rs"
    - "Cargo.toml"
  patterns:
    - "*.rs"
    - "*.toml"
  exclusions:
    - "target/**"
    - ".git/**"
  max_tokens: 1000
  include_hidden: false
  recursive: true

# Add a todo item
rhema todo add --title "Set up basic project structure" \
               --description "Create initial source files and tests" \
               --priority high \
               --assignee "developer"

# Record an insight about your project
rhema insight add --title "Project structure considerations" \
                  --content "Consider using a modular architecture for better maintainability" \
                  --confidence 8 \
                  --category "architecture"

# List all todos
rhema todo list
 
# Filter todos by status
rhema todo list --status pending
 
# Filter todos by priority
rhema todo list --priority high
 
# Update a todo
rhema todo update --id "TODO-001" --status "in-progress"
 
# Complete a todo
rhema todo complete --id "TODO-001" --outcome "Successfully implemented feature"

# Add insights as you work
rhema insight add --title "Performance optimization opportunity" \
                  --content "Database queries can be optimized by adding indexes" \
                  --confidence 9 \
                  --category "performance" \
                  --tags "database,optimization"
 
# Search insights
rhema insight search --query "performance"
 
# List insights by category
rhema insight list --category "performance"

# Record a pattern you've identified
rhema pattern add --name "Error handling pattern" \
                  --description "Consistent error handling across modules" \
                  --type "code" \
                  --examples "src/error.rs,src/validation.rs"
 
# Search for patterns
rhema pattern search --query "error handling"

# Record an architectural decision
rhema decision add --title "Use async/await for I/O operations" \
                   --description "Decision to use async/await for better performance" \
                   --status "approved" \
                   --rationale "Improves performance and resource utilization" \
                   --alternatives "Synchronous I/O,Thread pools" \
                   --impact "Better scalability and user experience"

# Start interactive mode
rhema interactive
 
# In interactive mode, you can:
# - Type commands without 'rhema' prefix
# - Use tab completion
# - See command history
# - Get contextual help

# Update multiple todos at once
rhema todo batch --file todos-update.yaml
 
# Add multiple insights from a file
rhema insight batch --file insights.yaml

# Query across all context data
rhema query "todos where priority = 'high' and status = 'pending'"
 
# Complex queries
rhema query "insights where confidence > 8 and category = 'performance'"
 
# Cross-scope queries
rhema query "todos,insights where assignee = 'developer'"

# Validate your project configuration
rhema validate
 
# Check project health
rhema health
 
# Validate lock file
rhema lock validate

# Initialize Git repository
git init
 
# Add Rhema files to Git
git add .rhema/
git commit -m "Initial Rhema configuration"
 
# Set up Git hooks (optional)
rhema git setup-hooks

name: Rhema Validation
 
on: [push, pull_request]
 
jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
      - run: cargo install rhema
      - run: rhema validate
      - run: rhema health

# Set global configuration
rhema config set --global editor "code"
rhema config set --global default-priority "medium"
rhema config set --global auto-save true
 
# View global configuration
rhema config get --global

# Project-specific settings
project:
  name: "my-rhema-project"
  auto_backup: true
  backup_interval: "1h"
  
# Editor integration
editor:
  default: "code"
  auto_open: true
  
# Validation settings
validation:
  strict: true
  auto_fix: false
  
# Performance settings
performance:
  cache_enabled: true
  cache_size: "100MB"
  parallel_processing: true

# If cargo install fails
rustup update
cargo clean
cargo install --force rhema

# Reset configuration
rhema config reset
 
# Validate configuration
rhema config validate

# Fix file permissions
chmod +x $(which rhema)
chmod -R 755 .rhema/

# Get help for any command
rhema --help
rhema <command> --help
 
# Check Rhema status
rhema status
 
# View logs
rhema logs