Skip to content

[codex] docs: update Ring installation instructions #398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
gandalf-at-lerian wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[codex] docs: update Ring installation instructions #398

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 23 additions & 91 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,120 +108,52 @@ The following plugins have been archived and are not actively maintained. They r

_To restore an archived plugin, move its folder from `.archive/` to the root directory and register it in `marketplace.json`._

## 🖥️ Supported Platforms
## 🖥️ Supported Platform

Ring works across multiple AI development platforms:
Ring is currently distributed as a **Claude Code plugin marketplace**.
The skills remain agent-agnostic, but the legacy multi-platform installer that copied and transformed assets for Factory AI, Cursor, Cline, Codex, and OpenCode has been removed.

| Platform | Format | Status | Features |
| --------------- | ----------- | ------------------ | ------------------------------- |
| **Claude Code** | Native | ✅ Source of truth | Skills, agents, hooks |
| **Factory AI** | Transformed | ✅ Supported | Droids, skills |
| **Cursor** | Transformed | ✅ Supported | Skills, agents |
| **Cline** | Transformed | ✅ Supported | Prompts |

**Transformation Notes:**

- Claude Code receives Ring content in its native format
- Factory AI: `agents` → `droids` terminology
- Cursor: Skills → ~/.cursor/skills/, Agents → ~/.cursor/agents/
- Cline: All content → structured prompts

**Platform-Specific Guides:**

See the [installer README](installer/) for platform-specific setup and transformation details.
| Platform | Format | Status | Features |
| --------------- | ------ | ------------------ | --------------------- |
| **Claude Code** | Native | ✅ Source of truth | Skills, agents, hooks |

## 🚀 Quick Start

### Multi-Platform Installation (Recommended)

The Ring installer automatically detects installed platforms and transforms content appropriately.

**Linux/macOS/Git Bash:**
### Claude Code Plugin Marketplace

```bash
# Interactive installer (auto-detects platforms)
curl -fsSL https://raw.githubusercontent.com/lerianstudio/ring/main/install-ring.sh | bash
# Add the Ring marketplace
claude plugin marketplace add lerianstudio/ring

# Or clone and run locally
git clone https://github.com/lerianstudio/ring.git ~/ring
cd ~/ring
./installer/install-ring.sh
# Install the required core plugin
claude plugin install ring-default
```

**Windows PowerShell:**

```powershell
# Interactive installer (auto-detects platforms)
irm https://raw.githubusercontent.com/lerianstudio/ring/main/install-ring.ps1 | iex

# Or clone and run locally
git clone https://github.com/lerianstudio/ring.git $HOME\ring
cd $HOME\ring
.\installer\install-ring.ps1
```

### Direct Platform Installation

Install to specific platforms without the interactive menu:
Optional plugin packs:

```bash
# Install to Claude Code only (native format)
./installer/install-ring.sh install --platforms claude

# Install to Factory AI only (droids format)
./installer/install-ring.sh install --platforms factory

# Install to multiple platforms
./installer/install-ring.sh install --platforms claude,cursor,cline

# Install to all detected platforms
./installer/install-ring.sh install --platforms auto

# Dry run (preview changes without installing)
./installer/install-ring.sh install --platforms auto --dry-run
claude plugin install ring-dev-team
claude plugin install ring-pm-team
claude plugin install ring-tw-team
```

### Installer Commands
Update installed plugins:

```bash
# List installed platforms and versions
./installer/install-ring.sh list

# Update existing installation
./installer/install-ring.sh update

# Check for available updates
./installer/install-ring.sh check

# Sync (update only changed files)
./installer/install-ring.sh sync

# Uninstall from specific platform
./installer/install-ring.sh uninstall --platforms cursor

# Detect available platforms
./installer/install-ring.sh detect
claude plugin marketplace update ring
claude plugin update ring-default
claude plugin update ring-dev-team
claude plugin update ring-pm-team
claude plugin update ring-tw-team
```

### Claude Code Plugin Marketplace

For Claude Code users, you can also install from the marketplace:
You can also install from the Claude Code UI:

- Open Claude Code
- Go to Settings → Plugins
- Search for "ring"
- Click Install

### Manual Installation (Claude Code only)

```bash
# Clone the marketplace repository
git clone https://github.com/lerianstudio/ring.git ~/ring

# Skills auto-load at session start via hooks
# No additional configuration needed for Claude Code
```

### Code Analysis Pipeline

The codereview pipeline uses [Mithril](https://github.com/LerianStudio/mithril), an external code analysis tool installed via `go install`. Mithril performs static analysis, AST extraction, call graph generation, and context compilation for AI-assisted code review.
Expand Down Expand Up @@ -613,7 +545,7 @@ ring/ # Monorepo root
- [CLAUDE.md](CLAUDE.md) - Repository guide for Claude Code
- [MANUAL.md](MANUAL.md) - Quick reference for all skills, agents, and workflows
- [ARCHITECTURE.md](ARCHITECTURE.md) - Architecture diagrams and component relationships
- [Installer](installer/) - Multi-platform installation and migration
- [.claude-plugin/marketplace.json](.claude-plugin/marketplace.json) - Plugin marketplace manifest and versions

## 🎯 Philosophy

Expand Down