Skip to content

docs: hide uteke memory integration from user-facing docs #367

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

Merged
ajianaz merged 1 commit into from
Jul 23, 2026
Merged

docs: hide uteke memory integration from user-facing docs #367

Show file tree
Hide file tree
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
29 changes: 1 addition & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,7 @@ Pick **one** install method — mixing channels can leave stale binaries on your
| **Pre-built binaries** | Manual download from [Releases](https://github.com/codecoradev/cora-code/releases) |

```bash
# Recommended: Cora only (standalone)
curl -fsSL https://raw.githubusercontent.com/codecoradev/cora-code/main/install.sh | sh

# Or install both Cora + Uteke (code review with memory)
# Install with the quick installer
curl -fsSL https://raw.githubusercontent.com/codecoradev/cora-code/main/install-bundle.sh | sh

# Or build from source with cargo
Expand Down Expand Up @@ -211,30 +208,6 @@ Works on **all CI platforms** — [Gitea, GitLab, Bitbucket →](https://codecor

See **[CLI Reference →](https://codecora.dev/cli-reference.html)** for all flags and examples.

## Uteke Memory Integration

Cora works 100% standalone. Install [Uteke](https://github.com/codecoradev/uteke) to unlock **memory-powered reviews** that learn from your codebase history.

| Mode | Command | What it does |
|------|---------|-------------|
| Standalone (default) | `cora review` | AI review, zero deps |
| Memory recall | `cora review --memory` | Recall project patterns before review |
| Learning | `cora review --memory --learn` | Recall + save findings after review |

```bash
# Install Uteke separately
curl -fsSL https://raw.githubusercontent.com/codecoradev/uteke/main/install.sh | sh

# Or install both at once
curl -fsSL https://raw.githubusercontent.com/codecoradev/cora-code/main/install-bundle.sh | sh

# Enable memory
export PATH="$HOME/.local/bin:$PATH"
cora review --staged --memory --learn
```

Your code review gets smarter every sprint.

## Environment Variables

| Variable | Description |
Expand Down
10 changes: 0 additions & 10 deletions docs/cli-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ Complete command reference for the cora CLI.
| `cora commit --edit` | Always open `$EDITOR` to edit message |
| `cora review` | Review code changes (default: staged files) |
| `cora review --staged` | Review staged git changes explicitly |
| `cora review --memory` | Recall project patterns from Uteke before review |
| `cora review --learn` | Recall + save findings to Uteke (implies --memory) |
| `cora review --unstaged` | Review unstaged working changes |
| `cora review --unpushed` | Review unpushed commits |
| `cora review --base` `<branch>` | Compare current branch against target |
Expand Down Expand Up @@ -101,14 +99,6 @@ $ cora commit
$ cora commit --yolo
```

```bash
# Install both Cora + Uteke (code review with memory)
$ curl -fsSL https://raw.githubusercontent.com/codecoradev/cora-code/main/install-bundle.sh | sh

# Then review with memory:
$ cora review --staged --memory --learn
```

```bash
# Index your project and search with Brain Mode
$ cora index
Expand Down
24 changes: 0 additions & 24 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,30 +407,6 @@ cora debt --branch develop # Filter by branch

Snapshots are auto-saved after every review (best-effort, never fails the review).

## Uteke Memory Integration

cora can optionally integrate with [Uteke](https://github.com/codecoradev/uteke) — a local-first memory engine for AI agents.

### Prerequisites

Install Uteke: `curl -fsSL https://raw.githubusercontent.com/codecoradev/uteke/main/install.sh | sh`

### Usage

```bash
cora review # Standalone review (default, no memory)
cora review --memory # Recall project patterns before review
cora review --memory --learn # Recall + save findings after review
```

### How It Works

1. **`--memory`**: Cora calls `uteke recall` to fetch project-specific patterns from previous reviews, enriching the LLM prompt with historical context.

2. **`--learn`**: After review, Cora calls `uteke remember` to save findings, patterns, and stats for future recall.

3. **Graceful degradation**: If Uteke is not installed, Cora warns and continues without memory. Reviews never fail due to memory issues.

## MCP Server

cora includes a built-in MCP (Model Context Protocol) server that exposes rules and config to AI coding agents like Claude Code, Cursor, Copilot, and Windsurf.
Expand Down
22 changes: 0 additions & 22 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,28 +150,6 @@ Or skip the prompt in CI/trusted workflows:
cora commit --yolo # auto-commit, no prompts
```

### Memory-Powered Reviews (Optional)

Install [Uteke](https://github.com/codecoradev/uteke) to give Cora a memory:

```bash
# Install both tools
curl -fsSL https://raw.githubusercontent.com/codecoradev/cora-code/main/install-bundle.sh | sh
```

Then enable memory in reviews:

```bash
cora review --staged --memory # recall project patterns
cora review --staged --memory --learn # recall + save findings
```

- `--memory` — Cora recalls past review findings and code patterns from Uteke before reviewing
- `--learn` — After review, Cora saves findings to Uteke for future recall
- Works with any review mode (staged, unpushed, branch)

Your code review gets smarter every sprint.

## AI Agent Integration

cora includes a built-in MCP server for AI coding agents. After installation:
Expand Down
41 changes: 0 additions & 41 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,47 +175,6 @@ $ cora review --staged --exclude "**/*.test.ts" --exclude "**/generated/**"

Alternatively, set include/exclude patterns in `.cora.yaml` for persistent configuration.

## Uteke Memory Integration

Cora works standalone. Install [Uteke](https://github.com/codecoradev/uteke) to unlock reviews that learn from your codebase history.

### Three Levels

| Level | Command | Uteke Required | What It Does |
|-------|---------|:---:|-------------|
| **Standalone** | `cora review` | No | AI review, zero deps |
| **Recall** | `cora review --memory` | Yes | Recall project patterns before review |
| **Learning** | `cora review --memory --learn` | Yes | Recall + save findings after review |

### Install Both

```bash
curl -fsSL https://raw.githubusercontent.com/codecoradev/cora-code/main/install-bundle.sh | sh
```

### Usage

```bash
# Review with memory recall
cora review --staged --memory

# Review + save to memory (reviews improve over time)
cora review --staged --memory --learn

# Works with all review modes
cora review --base main --memory --learn
cora commit --memory # Note: --memory only on review, not commit
```

### How It Works

1. Before review, Cora calls `uteke recall` to find relevant memories (past findings, code patterns)
2. These memories are injected into the LLM prompt as context
3. After review (with `--learn`), findings are saved to Uteke via `uteke remember`
4. Next review benefits from accumulated knowledge

Cora auto-detects Uteke on PATH. If not installed, memory features are silently disabled.

## Exit Codes

cora uses standard exit codes for scripting and CI integration:
Expand Down
Loading
Loading