repocheckai

KO | EN

gitlite — search

#python #hacktoberfest #ai #typescript #go #golang #android #deep-learning #docker #java #awesome #vue #pytorch #openai

(★ 121)

Agentic CLI Tool for GitHub Repository Health Analysis

repocheckai 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">🩺 RepoCheckAI</h1>

AI-powered GitHub Repository Health Analyzer 
 Built with the <a href="https://github.com/github/copilot-sdk">GitHub Copilot SDK</a> — the same AI agent runtime that powers Copilot CLI.

<a href="https://glaucia86.github.io/repocheckai/">Website</a> •
 <a href="#-quick-start">Quick Start</a> •
 <a href="#-features">Features</a> •
 <a href="#-how-it-works">How It Works</a> •
 <a href="#-commands">Commands</a> •
 <a href="#-documentation">Documentation</a>

---

## 📖 Overview

**RepoCheckAI** is your repository's AI doctor that diagnoses issues and prescribes solutions. It performs comprehensive health checks across **6 critical areas** — documentation, developer experience, CI/CD, testing, governance, and security — delivering a detailed diagnosis with prioritized findings (**P0/P1/P2**) and actionable remediation steps.

### Two Analysis Modes

| Mode | Description | Use Case |
|------|-------------|----------|
| 🔍 **Quick Scan** | Analyzes via GitHub API (up to 20 file reads) | Fast checks, governance review |
| 🔬 **Deep Analysis** | Full source scan using [Repomix](https://github.com/yamadashy/repomix) | Code quality, architecture review |

---

## ✨ Features

### 🤖 AI-Powered Analysis
- **20+ AI Models** — including `auto`, GPT-4o, Claude Sonnet 4, GPT-5.5, Claude Opus 4.7, and more
- **Contextual Understanding** — Adapts to your stack
- **Evidence-Based** — Every finding backed by file evidence

</td>
<td width="50%">

### 📊 Comprehensive Reports
- **Health Score** — Overall percentage (0-100%)
- **Prioritized Findings** — P0 (critical), P1 (high), P2 (suggestions)
- **Actionable Steps** — Code snippets included

</td>
</tr>
<tr>
<td width="50%">

### 💬 Interactive CLI
- **Slash Commands** — `/analyze`, `/deep`, `/copy`, `/export`
- **Chat Interface** — Ask follow-up questions
- **Streaming Output** — Real-time analysis

</td>
<td width="50%">

### Auto-Publish Issues
- **One-Click Issue Creation** — `--issue` flag creates structured GitHub issues
- **Prioritized Findings** — P0/P1/P2 labels with detailed descriptions
- **Team Collaboration** — Automated tracking of repository health issues
- **CI/CD Integration** — Perfect for automated health checks

</td>
</tr>
<tr>
<td width="50%">

### 🔐 Security First
- **Prompt Injection Protection** — File content treated as data
- **Token Management** — Secure GitHub authentication
- **No Data Storage** — Analysis runs locally

</td>
</tr>
</table>

### 📢 Publishing Features

**Automatically publish analysis reports to GitHub as structured issues:**

#### 🚀 Auto-Create Issues for Each Problem Found
```bash
export GITHUB_TOKEN=ghp_xxx          # or REPOCHECKAI_GITHUB_TOKEN, as configured
repocheck analyze owner/repo --issue
# Creates: 🔴 [RepoCheckAI] docs: Missing README
#         🟠 [RepoCheckAI] ci: No CI/CD Pipeline
#         🟡 [RepoCheckAI] dx: Code Quality Issues
```

**Each issue includes:**
- **Detailed description** with evidence and impact assessment
- **Actionable fix instructions** with code examples
- **Priority labels** (P0/P1/P2) and category tags
- **Full analysis context** for team collaboration

#### 💬 Interactive Mode
```bash
# Set token securely (recommended)
export GITHUB_TOKEN=ghp_your_token_here

# Or use gh CLI auth
gh auth login

# Then start interactive mode
repocheck chat
/analyze facebook/react --issue
/deep microsoft/vscode
```

> [!TIP]
> Perfect for automated repository health tracking and team collaboration!

[📖 Learn how to set up GitHub tokens](docs/getting-started.md#testing-publishing-features)

---

## � Quick Start (5 minutes)

Want to see RepoCheckAI create GitHub issues automatically?

```bash
# 1. Get a GitHub token (see detailed setup below)
# 2. Set it as environment variable
export GITHUB_TOKEN=ghp_your_token_here

# 3. Analyze and create issues automatically!
repocheck analyze your-username/your-repo --issue
```

**Result:** Multiple GitHub issues created with detailed analysis, impact assessment, and fix instructions! 🎉

### 🔑 Setting up GitHub Token

For the `--issue` feature, you'll need a GitHub Personal Access Token with specific permissions:

1. **Go to** [github.com/settings/tokens](https://github.com/settings/tokens)
2. **Generate** a new "Tokens (classic)"
3. **Select these scopes**:
   - `repo` (full repository access) **OR** the following granular permissions:
     - `metadata` — Read repository metadata
     - `contents` — Read repository contents
     - `issues` — Create and manage issues
4. **Copy** the token (starts with `ghp_`)

> [!IMPORTANT]
> [📖 Complete setup guide with screenshots](docs/getting-started.md#testing-publishing-features)

---

## 🧭 Issue Publishing TL;DR

`--issue` (CLI) and `Publish to GitHub Issues` (Web UI) both need GitHub API credentials with issue-write permission.

### CLI

```bash
export GITHUB_TOKEN=ghp_your_pat_here
repocheck analyze owner/repo --issue
```

### Web UI

```bash
npm run dev:local-ui
```

In the form:
1. Enable `Publish to GitHub Issues`
2. Optional: paste `GitHub Token` (overrides server env token)
3. Run analysis

If no token is provided in the field, the backend uses `GITHUB_TOKEN` from the server environment.

For full step-by-step setup and 401/403 troubleshooting, see [docs/issue-publishing.md](docs/issue-publishing.md).

---

| Category | What's Checked | Example Findings |
|----------|----------------|------------------|
| 📚 **Docs & Onboarding** | README, setup instructions, contributing guidelines | Missing installation steps |
| ⚡ **Developer Experience** | Build scripts, language version, project structure | No `.nvmrc` or `.node-version` |
| 🔄 **CI/CD** | GitHub Actions, test automation, build pipelines | No CI workflow found |
| 🧪 **Quality & Tests** | Test framework, linting, formatting, coverage | Missing test configuration |
| 📋 **Governance** | LICENSE, CODE_OF_CONDUCT, SECURITY policy | No LICENSE file |
| 🔐 **Security** | Dependabot/Renovate, security policy, secret scanning | No dependency updates configured |

---

## 🚀 Quick Start

### Prerequisites

> [!IMPORTANT]
> - **GitHub Copilot** — An active Copilot plan is required
> - **Node.js** — Version 24.0.0 or higher

### Installation

```bash
# Clone the repository
git clone https://github.com/glaucia86/repocheckai.git
cd repocheckai

# Install dependencies and build
npm install
npm run build

# Link globally
npm link
```

### Usage

```bash
# Interactive mode
repocheck

# Direct analysis
repocheck vercel/next.js

# Deep analysis with premium model
repocheck vercel/next.js --model claude-sonnet-4 --deep

# 🚀 Auto-create GitHub issues for each problem found
repocheck vercel/next.js --issue
```

> [!NOTE]
> `--issue` requires a GitHub token. [Learn how to set it up](docs/getting-started.md#testing-publishing-features).

---

## 🔧 How It Works

![alt text](https://raw.githubusercontent.com/glaucia86/repocheckai/main/resources/how-it-works.png)

---

## 📖 Commands

| Command | Description |
|---------|-------------|
| `/analyze <repo>` | Quick analysis via GitHub API |
| `/deep <repo>` | Deep analysis with full source scan |
| `/copy` | Copy last report to clipboard |
| `/export [path]` | Save report as markdown file |
| `/model [name]` | Switch AI model (now works in onboarding phase) |
| `/help` | Show all available commands |
| `/quit` | Exit RepoCheckAI |

> [!TIP]
> Use `/deep` for comprehensive code quality analysis. Use `/analyze` for quick governance checks.

## 🗂️ Repository Layout

The repository keeps application runtime code in `src/` and the public website in `site/`:

```text
site/          # Static marketing/docs site deployed to GitHub Pages
src/           # Clean architecture runtime code
```

Implementation source is now organized by clean architecture layers in `src/`:
- Presentation: `src/presentation/**` (CLI, API, Web UI, terminal UI)
- Application: `src/application/**` (analysis and reporting orchestration)
- Infrastructure: `src/infrastructure/**` (GitHub/providers/tools adapters)
- Domain: `src/domain/**` (schemas, contracts, interfaces)
- Shared utilities: `src/utils/**`

## 🖥️ Local Web UI

The project has a single Web UI implementation served from `src/presentation/web/public` by `src/presentation/web/main.ts`.

```bash
npm run dev:web-ui:api
npm run dev:web-ui
```

Or run both services together:

```bash
npm run dev:local-ui
```

Current MVP capabilities:
- Create analysis jobs from web state/client modules
- Read completed markdown/JSON reports
- Stream progress seeds and cancel running jobs
- Copy and export completed reports (`md` and `json`)

---

## 📝 Examples

### Quick Analysis
```bash
repocheck
/analyze microsoft/vscode
```

### Deep Analysis with Custom Model
```bash
repocheck
/model claude-sonnet-4
/deep facebook/react
```

### Export Report
```bash
repocheck
/analyze vercel/next.js
/export nextjs-report.md
```

### Interactive Mode
```bash
repocheck
# Then use commands interactively
/analyze myorg/myrepo
/copy
```

---

## 🤖 Available AI Models

| Model | Type | Best For |
|-------|------|----------|
| `auto` | Included | Lets Copilot choose the best model for the task |
| `gpt-4o` | Included | Fast, low-cost daily checks |
| `gpt-4.1` | Included | Reliable general-purpose analysis |
| `gpt-5-mini` | Included | Quick scans and lightweight repos |
| `claude-sonnet-4` | Premium ⚡ | Default model in RepoCheckAI |
| `gpt-5.3-codex` | Premium ⚡ | Strong code-focused analysis |
| `claude-opus-4.7` | Premium ⚡ | Current top-tier model for Pro+, Business, Enterprise |
| `gpt-5.5` | Premium ⚡ | Latest GPT rollout for complex agentic work |

> [!NOTE]
> Included chat models are available across Copilot plans, while premium model access depends on your plan. As of April 24, 2026, `GPT-5.5` and `Claude Opus 4.7` are rolling out to `Pro+`, `Business`, and `Enterprise`, and new self-serve signups for `Student`, `Pro`, and `Pro+` are paused. See [AI Models Guide](docs/AI-MODELS.md) for the current matrix.

---

## 📚 Documentation

| Document | Description |
|----------|-------------|
| [� Getting Started](docs/getting-started.md) | Installation and first analysis |
| [📖 User Guide](docs/GUIDE.md) | Complete usage guide with examples |
| [💻 Commands](docs/commands.md) | Full CLI command reference |
| [📊 Analysis Categories](docs/analysis-categories.md) | What gets analyzed in each category |
| [🤖 AI Models](docs/AI-MODELS.md) | Available models and recommendations |
| [🏗️ Architecture](docs/architecture.md) | Technical architecture and design |
| [❓ FAQ](docs/faq.md) | Frequently asked questions |
| [🔧 Troubleshooting](docs/troubleshooting.md) | Common issues and solutions |
| [🤝 Contributing](docs/CONTRIBUTING.md) | How to contribute to RepoCheckAI |

> 📖 **Full documentation:** [docs/index.md](docs/index.md)

---

## 🏗️ Tech Stack

<table>
<tr>
<td align="center" width="120">
<a href="https://github.com/github/copilot-sdk">
<img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png" width="48" height="48" alt="GitHub Copilot SDK"/>
</a>
 Copilot SDK
 AI Orchestration
</td>
<td align="center" width="120">
<a href="https://github.com/octokit/rest.js">
<img src="https://avatars.githubusercontent.com/u/3430433?s=200&v=4" width="48" height="48" alt="Octokit"/>
</a>
 Octokit
 GitHub API
</td>
<td align="center" width="120">
<a href="https://github.com/yamadashy/repomix">
<img src="https://repomix.com/images/repomix-logo.svg" width="48" height="48" alt="Repomix"/>
</a>
 Repomix
 Repo Packing
</td>
<td align="center" width="120">
<a href="https://www.typescriptlang.org/">
<img src="https://raw.githubusercontent.com/remojansen/logo.ts/master/ts.png" width="48" height="48" alt="TypeScript"/>
</a>
 TypeScript
 Language
</td>
<td align="center" width="120">
<a href="https://github.com/colinhacks/zod">
<img src="https://raw.githubusercontent.com/colinhacks/zod/main/logo.svg" width="48" height="48" alt="Zod"/>
</a>
 Zod
 Validation
</td>
</tr>
</table>

### 🔧 Modular Architecture

The codebase follows **SOLID principles** for maintainability:

```
src/
├── cli/          # Command handlers, state, parsers
├── core/agent/   # Copilot SDK session, modular prompts
├── tools/        # Individual tool files (SRP)
├── ui/display/   # Display modules (spinner, menus, etc.)
└── types/        # Zod schemas, interfaces
```

**Key Design Decisions:**
- **Agentic CLI**: Uses GitHub Copilot SDK for AI-powered analysis
- **Modular Prompts**: System prompts composed from reusable base modules
- **Tool-Based Architecture**: AI agent invokes specific tools for data gathering
- **Streaming Output**: Real-time analysis with event-driven updates
- **Security First**: Content sanitization prevents prompt injection

> 📖 See [Architecture Documentation](docs/architecture.md) for technical details.

---

## ⭐ Support This Project

If you find RepoCheckAI useful:

<table>
<tr>
<td>⭐ Star this repository</td>
<td>🐛 Report issues you encounter</td>
</tr>
<tr>
<td>💡 Suggest new features</td>
<td>🔀 Contribute via pull requests</td>
</tr>
</table>

---

## 📈 Star History

---

## 📄 License

---

## 👩‍💻 Author

<div align="center">
 <a href="https://github.com/glaucia86">
 <img src="https://github.com/glaucia86.png" width="100px;" alt="Glaucia Lemos" style="border-radius: 50%;"/>
 </a>
 
 Glaucia Lemos
 
 A.I Developer at Zup Innovation/Itaú
 
 <a href="https://mvp.microsoft.com/pt-BR/MVP/profile/d3200941-395d-423b-a0ec-eb0577d3bb86">
 <img src="https://img.shields.io/badge/Microsoft%20MVP-Web%20Technologies-blue?logo=microsoft&logoColor=white" alt="Microsoft MVP"/>
 </a>
 
 <a href="https://twitter.com/glaucia_lemos86">🐦 Twitter</a> •
 <a href="https://www.linkedin.com/in/glaucialemos/">💼 LinkedIn</a> •
 <a href="https://github.com/glaucia86">🐙 GitHub</a>
</div>

---

Made with 💚 using the GitHub Copilot SDK

repocheckai

repocheckai 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

repocheckai

repocheckai 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README