- Website •
+ Website •
Quick Start •
Features •
How It Works •
@@ -49,7 +49,7 @@
## 📖 Overview
-**Repo Doctor** 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.
+**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
@@ -118,11 +118,11 @@
#### 🚀 Auto-Create Issues for Each Problem Found
```bash
-export GITHUB_TOKEN=ghp_xxx # or REPO_DOCTOR_GITHUB_TOKEN, as configured
-repo-doctor analyze owner/repo --issue
-# Creates: 🔴 [Repo Doctor] docs: Missing README
-# 🟠 [Repo Doctor] ci: No CI/CD Pipeline
-# 🟡 [Repo Doctor] dx: Code Quality Issues
+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:**
@@ -140,7 +140,7 @@ export GITHUB_TOKEN=ghp_your_token_here
gh auth login
# Then start interactive mode
-repo-doctor chat
+repocheck chat
/analyze facebook/react --issue
/deep microsoft/vscode
```
@@ -154,7 +154,7 @@ repo-doctor chat
## � Quick Start (5 minutes)
-Want to see Repo Doctor create GitHub issues automatically?
+Want to see RepoCheckAI create GitHub issues automatically?
```bash
# 1. Get a GitHub token (see detailed setup below)
@@ -162,7 +162,7 @@ Want to see Repo Doctor create GitHub issues automatically?
export GITHUB_TOKEN=ghp_your_token_here
# 3. Analyze and create issues automatically!
-repo-doctor analyze your-username/your-repo --issue
+repocheck analyze your-username/your-repo --issue
```
**Result:** Multiple GitHub issues created with detailed analysis, impact assessment, and fix instructions! 🎉
@@ -185,101 +185,31 @@ For the `--issue` feature, you'll need a GitHub Personal Access Token with speci
---
-## 🧭 Detailed --issue Setup (and 401 Troubleshooting)
+## 🧭 Issue Publishing TL;DR
-This section explains, step by step, how to create the right token, avoid 401 errors, and run `--issue` safely. It also clarifies the two authentication paths used by Repo Doctor.
+`--issue` (CLI) and `Publish to GitHub Issues` (Web UI) both need GitHub API credentials with issue-write permission.
-### 1) Understand the two auth paths
+### CLI
-- **Copilot SDK auth (models and analysis)** uses GitHub Copilot access. If this fails, you will see: `Failed to list models: 401`.
-- **GitHub API auth (repo read + issue creation)** uses your PAT. If this fails, you will see 401/403 when listing files or creating issues.
-
-### 2) Clean environment (important)
-
-Do this before testing to avoid old tokens interfering.
-
-```powershell
-Remove-Item Env:GITHUB_TOKEN, Env:GH_TOKEN -ErrorAction SilentlyContinue
-```
-
-### 3) Authenticate Copilot SDK (fixes "Failed to list models: 401")
-
-Use GitHub CLI login to get an OAuth token that Copilot accepts.
-
-```powershell
-gh auth logout
-gh auth login
-```
-
-Choose:
-- Host: GitHub.com
-- Login via web
-- Git operations: HTTPS
-
-Confirm login:
-
-```powershell
-gh auth status
-```
-
-Export the token for Repo Doctor:
-
-```powershell
-$env:GH_TOKEN = (gh auth token)
-```
-
-### 4) Create a PAT for `--issue` (GitHub API)
-
-You have two supported paths. Classic PAT is the most reliable.
-
-#### Option A: Classic PAT (recommended)
-
-1. GitHub -> Settings -> Developer settings -> Personal access tokens -> **Tokens (classic)**
-2. Click **Generate new token (classic)**
-3. Select scopes:
- - `repo` (private + public) **or** `public_repo` (public only)
-4. Generate and copy the token once
-
-#### Option B: Fine-grained PAT
-
-1. GitHub -> Settings -> Developer settings -> Personal access tokens -> **Fine-grained tokens**
-2. **Repository access**:
- - **All repositories** (if you want to create issues in any repo you own)
- - or **Only select repositories** (recommended for least privilege)
-3. **Repository permissions** (minimum):
- - **Metadata**: Read-only (Required)
- - **Contents**: Read-only
- - **Issues**: Read and write
-4. **Account permissions**: keep **No access**
-
-### 5) Run Repo Doctor with `--issue`
-
-Use `GH_TOKEN` for Copilot and pass the PAT only for issue creation.
-
-```powershell
-# Copilot SDK auth (models/analysis)
-$env:GH_TOKEN = (gh auth token)
-
-# Run in dev (chat) and create issues
-npm run dev:cli
+```bash
+export GITHUB_TOKEN=ghp_your_pat_here
+repocheck analyze owner/repo --issue
```
-In the app:
+### Web UI
+```bash
+npm run dev:local-ui
```
-/deep owner/repo --issue --token
-```
-
-### 6) Quick diagnosis checklist
-- **401 on models**: Copilot auth failed -> redo Step 3 (gh auth + GH_TOKEN)
-- **401/403 on issue creation**: PAT lacks access or `Issues: Read/Write`
-- **Public repo but want issues**: PAT still needs `Issues: Read/Write`
-- **Org repo**: your account must have permission to create issues in that repo
+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 the complete step-by-step guide (including PAT creation screens and diagnostics), see [docs/issue-publishing.md](docs/issue-publishing.md).
+For full step-by-step setup and 401/403 troubleshooting, see [docs/issue-publishing.md](docs/issue-publishing.md).
---
@@ -306,8 +236,8 @@ For the complete step-by-step guide (including PAT creation screens and diagnost
```bash
# Clone the repository
-git clone https://github.com/glaucia86/repo-doctor.git
-cd repo-doctor
+git clone https://github.com/glaucia86/repocheckai.git
+cd repocheckai
# Install dependencies and build
npm install
@@ -321,16 +251,16 @@ npm link
```bash
# Interactive mode
-repo-doctor
+repocheck
# Direct analysis
-repo-doctor vercel/next.js
+repocheck vercel/next.js
# Deep analysis with premium model
-repo-doctor vercel/next.js --model claude-sonnet-4 --deep
+repocheck vercel/next.js --model claude-sonnet-4 --deep
# 🚀 Auto-create GitHub issues for each problem found
-repo-doctor vercel/next.js --issue
+repocheck vercel/next.js --issue
```
> [!NOTE]
@@ -354,7 +284,7 @@ repo-doctor vercel/next.js --issue
| `/export [path]` | Save report as markdown file |
| `/model [name]` | Switch AI model (now works in onboarding phase) |
| `/help` | Show all available commands |
-| `/quit` | Exit Repo Doctor |
+| `/quit` | Exit RepoCheckAI |
> [!TIP]
> Use `/deep` for comprehensive code quality analysis. Use `/analyze` for quick governance checks.
@@ -402,27 +332,27 @@ Current MVP capabilities:
### Quick Analysis
```bash
-repo-doctor
+repocheck
/analyze microsoft/vscode
```
### Deep Analysis with Custom Model
```bash
-repo-doctor
+repocheck
/model claude-sonnet-4
/deep facebook/react
```
### Export Report
```bash
-repo-doctor
+repocheck
/analyze vercel/next.js
/export nextjs-report.md
```
### Interactive Mode
```bash
-repo-doctor
+repocheck
# Then use commands interactively
/analyze myorg/myrepo
/copy
@@ -458,7 +388,7 @@ repo-doctor
| [🏗️ 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 Repo Doctor |
+| [🤝 Contributing](docs/CONTRIBUTING.md) | How to contribute to RepoCheckAI |
> 📖 **Full documentation:** [docs/index.md](docs/index.md)
@@ -532,7 +462,7 @@ src/
## ⭐ Support This Project
-If you find Repo Doctor useful:
+If you find RepoCheckAI useful:
@@ -546,11 +476,11 @@ If you find Repo Doctor useful:
+
diff --git a/docs/announcements/repocheckai-migration.md b/docs/announcements/repocheckai-migration.md
new file mode 100644
index 0000000..ee3020b
--- /dev/null
+++ b/docs/announcements/repocheckai-migration.md
@@ -0,0 +1,50 @@
+# RepoCheckAI Migration Announcement
+
+Date: 2026-02-17
+
+## Summary
+
+`Repo Check AI` is now `RepoCheckAI`.
+
+- Official npm package: `repocheckai`
+- Official CLI command: `repocheck`
+- Legacy command in transition: `repodoctor`
+
+## Why We Changed
+
+The new identity aligns product name, package name, and command conventions while keeping continuity for existing users.
+
+## Command Transition Policy
+
+- Effective release: `2.5.0`
+- Legacy support window: `2` releases
+- Legacy support until: `2.6.x`
+
+During transition:
+
+- `repocheck` is the default and recommended command.
+- `repodoctor` still runs, but shows a deprecation warning.
+
+After transition:
+
+- `repodoctor` will be rejected with migration guidance.
+
+## What You Need To Do
+
+1. Update scripts and docs to use `repocheck`.
+2. Ensure installation references `npm i -g repocheckai`.
+3. Remove hard dependencies on `repodoctor` before the end of the transition window.
+
+## Migration Examples
+
+```bash
+# install
+npm i -g repocheckai
+
+# old (transition only)
+repodoctor analyze owner/repo
+
+# new (recommended)
+repocheck analyze owner/repo
+```
+
diff --git a/docs/architecture.md b/docs/architecture.md
index 81b6a53..4ee8e76 100644
--- a/docs/architecture.md
+++ b/docs/architecture.md
@@ -1,6 +1,6 @@
# 🏗️ Architecture
-Technical overview of Repo Doctor's architecture and design decisions.
+Technical overview of Repo Check AI's architecture and design decisions.
---
@@ -19,11 +19,11 @@ Technical overview of Repo Doctor's architecture and design decisions.
## System Overview
-Repo Doctor is built as an **agentic CLI tool** using the GitHub Copilot SDK. It leverages AI to analyze GitHub repositories and provide health assessments.
+Repo Check AI is built as an **agentic CLI tool** using the GitHub Copilot SDK. It leverages AI to analyze GitHub repositories and provide health assessments.
```mermaid
flowchart TB
- subgraph RD["🩺 REPO DOCTOR"]
+ subgraph RD["🩺 REPO CHECK AI"]
direction TB
subgraph Input["📥 Input Layer"]
@@ -92,7 +92,7 @@ graph LR
## Project Structure
```
-repo-doctor/
+repocheckai/
├── site/ # Static website (GitHub Pages)
│
├── src/
@@ -252,7 +252,7 @@ export function createOctokit(token?: string): Octokit {
return new Octokit({
auth: resolvedToken,
- userAgent: "repo-doctor",
+ userAgent: "repocheckai",
});
}
```
@@ -585,7 +585,7 @@ function sanitizeFilePath(path: string): string | null {
- Environment variables are preferred
- GitHub CLI integration for secure auth
-Repo Doctor uses two auth paths:
+Repo Check AI uses two auth paths:
- Copilot SDK auth via GitHub CLI OAuth token (exported as `GH_TOKEN`)
- GitHub API auth for repo access and `--issue` via PAT (`GITHUB_TOKEN` or `--token`)
@@ -669,3 +669,4 @@ export const colors = {
+
+
+
+
diff --git a/docs/faq.md b/docs/faq.md
index 80f5c38..69dc0bd 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -1,6 +1,6 @@
# ❓ Frequently Asked Questions
-Common questions about using Repo Doctor.
+Common questions about using RepoCheckAI.
---
@@ -17,15 +17,15 @@ Common questions about using Repo Doctor.
## General Questions
-### What is Repo Doctor?
+### What is RepoCheckAI?
-Repo Doctor is an AI-powered CLI tool that analyzes GitHub repositories for health issues. It checks documentation, developer experience, CI/CD, testing, governance, and security practices, then provides a detailed report with prioritized findings and actionable recommendations.
+RepoCheckAI is an AI-powered CLI tool that analyzes GitHub repositories for health issues. It checks documentation, developer experience, CI/CD, testing, governance, and security practices, then provides a detailed report with prioritized findings and actionable recommendations.
### How is it different from other code analysis tools?
Unlike traditional linters or static analysis tools that focus on code syntax:
-| Aspect | Traditional Tools | Repo Doctor |
+| Aspect | Traditional Tools | RepoCheckAI |
|--------|------------------|-------------|
| Focus | Code syntax/style | Project health & best practices |
| Scope | Single language | Any language/framework |
@@ -35,7 +35,7 @@ Unlike traditional linters or static analysis tools that focus on code syntax:
### What languages/frameworks does it support?
-Repo Doctor supports **all languages and frameworks**. It automatically detects your stack and adapts its analysis:
+RepoCheckAI supports **all languages and frameworks**. It automatically detects your stack and adapts its analysis:
- **JavaScript/TypeScript** (Node.js, React, Vue, etc.)
- **Python** (Django, Flask, FastAPI, etc.)
@@ -69,7 +69,7 @@ Your code is processed through the GitHub Copilot API, which has enterprise-grad
### Why do I need GitHub Copilot?
-Repo Doctor uses the [GitHub Copilot SDK](https://github.com/github/copilot-sdk) for AI capabilities. This SDK requires an active GitHub Copilot subscription.
+RepoCheckAI uses the [GitHub Copilot SDK](https://github.com/github/copilot-sdk) for AI capabilities. This SDK requires an active GitHub Copilot subscription.
**Subscription options:**
- GitHub Copilot Individual ($10/month)
@@ -118,7 +118,7 @@ See [Troubleshooting](troubleshooting.md) for more solutions.
**Use `/analyze`** for quick health checks and governance reviews.
**Use `/deep`** for detailed audits and code quality analysis.
-### What files does Repo Doctor read?
+### What files does RepoCheckAI read?
**Quick analysis (`/analyze`) reads:**
- `README.md`
@@ -198,7 +198,7 @@ Yes! Switch models anytime:
```bash
# Via command line
-repo-doctor owner/repo --model gpt-4o
+repocheck owner/repo --model gpt-4o
# In interactive mode
/model claude-sonnet-4
@@ -225,13 +225,13 @@ Yes! You need to provide a GitHub token with `repo` scope:
```bash
# Option 1: Environment variable
export GITHUB_TOKEN=ghp_xxxxxxxxxxxx
-repo-doctor my-org/private-repo
+repocheck my-org/private-repo
# Option 2: Command line
-repo-doctor my-org/private-repo --token ghp_xxxxxxxxxxxx
+repocheck my-org/private-repo --token ghp_xxxxxxxxxxxx
# Option 3: GitHub CLI (if authenticated)
-gh auth login # Then Repo Doctor auto-detects
+gh auth login # Then RepoCheckAI auto-detects
```
### What token scopes are required?
@@ -275,6 +275,7 @@ See [issue-publishing.md](issue-publishing.md) for the full step-by-step guide.
### Why does `--issue` return 401/403?
Your PAT lacks write access to issues or does not have repo access.
+The same rule applies to Web UI publishing (`Publish to GitHub Issues`).
- Classic PAT: ensure `repo` (or `public_repo`) is selected
- Fine-grained PAT: ensure **Metadata (read)**, **Contents (read)**, **Issues (read/write)**
@@ -284,9 +285,9 @@ Your PAT lacks write access to issues or does not have repo access.
## Pricing & Limits
-### Is Repo Doctor free?
+### Is RepoCheckAI free?
-Repo Doctor is **open source and free**. However, it requires:
+RepoCheckAI is **open source and free**. However, it requires:
- **GitHub Copilot subscription** (paid)
- **GitHub API access** (free with limits)
@@ -311,7 +312,7 @@ You'll see an error like "Rate limit exceeded". Solutions:
### Are there costs for AI usage?
-AI usage is included in your GitHub Copilot subscription. There are no additional charges from Repo Doctor.
+AI usage is included in your GitHub Copilot subscription. There are no additional charges from RepoCheckAI.
**Note:** Premium models like `claude-opus-4.5` consume rate limits faster (3x cost), which may affect your Copilot usage for other tools.
@@ -319,8 +320,8 @@ AI usage is included in your GitHub Copilot subscription. There are no additiona
## More Questions?
-- 💬 [Start a Discussion](https://github.com/glaucia86/repo-doctor/discussions)
-- 🐛 [Report an Issue](https://github.com/glaucia86/repo-doctor/issues)
+- 💬 [Start a Discussion](https://github.com/glaucia86/repocheckai/discussions)
+- 🐛 [Report an Issue](https://github.com/glaucia86/repocheckai/issues)
- 📖 [Read the Full Documentation](index.md)
---
@@ -328,3 +329,5 @@ AI usage is included in your GitHub Copilot subscription. There are no additiona
+
+
diff --git a/docs/getting-started.md b/docs/getting-started.md
index b25e8ed..743a93d 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -1,12 +1,14 @@
# 🚀 Getting Started
-This guide will help you install Repo Doctor and run your first repository health analysis.
+This guide will help you install RepoCheckAI and run your first repository health analysis.
+
+> Transition note: use `repocheck` as the default command. Legacy `repodoctor` remains available only during the migration window.
---
## ⚡ Quick Start (5 minutes)
-Want to see Repo Doctor in action? Here's how to test the GitHub issue creation feature:
+Want to see RepoCheckAI in action? Here's how to test the GitHub issue creation feature:
### 1. Get a GitHub Token
@@ -23,15 +25,15 @@ Want to see Repo Doctor in action? Here's how to test the GitHub issue creation
export GITHUB_TOKEN=ghp_your_token_here
# This may create one or multiple GitHub issues automatically, depending on findings/output format.
-repo-doctor analyze your-username/your-repo --issue
+repocheck analyze your-username/your-repo --issue
```
### 3. Check the Results
Visit your repository's **Issues** tab - you should see new issues like:
-- 🔴 [Repo Doctor] docs: Missing README
-- 🟠 [Repo Doctor] ci: No CI/CD Pipeline
-- 🟡 [Repo Doctor] dx: Code Quality Issues
+- 🔴 [RepoCheckAI] docs: Missing README
+- 🟠 [RepoCheckAI] ci: No CI/CD Pipeline
+- 🟡 [RepoCheckAI] dx: Code Quality Issues
**That's it!** 🎉 Each issue contains detailed analysis, impact assessment, and fix instructions.
@@ -41,7 +43,7 @@ Visit your repository's **Issues** tab - you should see new issues like:
## Prerequisites
-Before installing Repo Doctor, ensure you have:
+Before installing RepoCheckAI, ensure you have:
### 1. Node.js (v18+)
@@ -58,7 +60,7 @@ If you need to install or update Node.js:
### 2. GitHub Copilot Subscription
-Repo Doctor uses the GitHub Copilot SDK, which requires an active subscription:
+RepoCheckAI uses the GitHub Copilot SDK, which requires an active subscription:
- **GitHub Copilot Individual** - Works with free models (GPT-4o, GPT-4.1)
- **GitHub Copilot Pro/Business/Enterprise** - Full access to premium models
@@ -67,7 +69,7 @@ Repo Doctor uses the GitHub Copilot SDK, which requires an active subscription:
### 3. GitHub Copilot CLI (Required)
-Repo Doctor uses the GitHub Copilot SDK, which requires the **Copilot CLI** installed:
+RepoCheckAI uses the GitHub Copilot SDK, which requires the **Copilot CLI** installed:
```bash
# Install Copilot CLI
@@ -113,7 +115,7 @@ Then authenticate:
gh auth login
```
-> **Tip:** For model access, Repo Doctor uses the GitHub CLI OAuth token. If you see `Failed to list models: 401`, follow the Copilot auth steps in [issue-publishing.md](issue-publishing.md).
+> **Tip:** For model access, RepoCheckAI uses the GitHub CLI OAuth token. If you see `Failed to list models: 401`, follow the Copilot auth steps in [issue-publishing.md](issue-publishing.md).
### 5. GitHub Personal Access Token (For Publishing Features)
@@ -132,7 +134,7 @@ To use advanced features like creating issues or commenting on PRs, you need a G
3. **Generate New Token**
- Click **Generate new token (classic)**
- - **Name**: `Repo Doctor` (or descriptive name)
+ - **Name**: `RepoCheckAI` (or descriptive name)
- **Expiration**: Choose appropriate time (30 days recommended)
- **Scopes**: Select minimal required permissions
@@ -152,7 +154,7 @@ To use advanced features like creating issues or commenting on PRs, you need a G
export GITHUB_TOKEN=ghp_your_token_here
# Or pass it only for a single command (avoids storing it in shell history)
-GITHUB_TOKEN=ghp_your_token_here repo-doctor analyze owner/repo --issue
+GITHUB_TOKEN=ghp_your_token_here repocheck analyze owner/repo --issue
```
> **Full guide:** See [issue-publishing.md](issue-publishing.md) for step-by-step `--issue` setup and 401 troubleshooting.
@@ -172,10 +174,10 @@ GITHUB_TOKEN=ghp_your_token_here repo-doctor analyze owner/repo --issue
```bash
# 1. Clone the repository
-git clone https://github.com/glaucia86/repo-doctor.git
+git clone https://github.com/glaucia86/repocheckai.git
# 2. Navigate to the directory
-cd repo-doctor
+cd repocheckai
# 3. Install dependencies
npm install
@@ -187,7 +189,7 @@ npm run build
npm link
```
-After installation, the `repo-doctor` command will be available globally.
+After installation, the `repocheck` command will be available globally.
### Option 2: Development Mode
@@ -195,8 +197,8 @@ If you want to contribute or modify the code:
```bash
# Clone and install
-git clone https://github.com/glaucia86/repo-doctor.git
-cd repo-doctor
+git clone https://github.com/glaucia86/repocheckai.git
+cd repocheckai
npm install
# Run in development mode (with hot reload)
@@ -206,8 +208,8 @@ npm run dev:cli
### Verify Installation
```bash
-repo-doctor --version
-# Should display: repo-doctor v2.x.x
+repocheck --version
+# Should display: repocheck v2.x.x
```
---
@@ -219,13 +221,13 @@ repo-doctor --version
The easiest way to start is with interactive mode:
```bash
-repo-doctor
+repocheck
```
You'll see a welcome screen:
-
+
1. **Enter a repository** — Type `vercel/next.js` or any public repository
@@ -239,17 +241,17 @@ You can also analyze directly from the command line:
```bash
# Analyze a public repository
-repo-doctor vercel/next.js
+repocheck vercel/next.js
# With a specific model
-repo-doctor facebook/react --model gpt-4o
+repocheck facebook/react --model gpt-4o
# Deep analysis (comprehensive scan)
-repo-doctor microsoft/typescript --deep
+repocheck microsoft/typescript --deep
# 🔥 NEW: Create GitHub issues automatically
export GITHUB_TOKEN=ghp_your_token_here
-repo-doctor analyze your-username/your-repo --issue
+repocheck analyze your-username/your-repo --issue
```
### Publishing Reports to GitHub
@@ -265,122 +267,54 @@ repo-doctor analyze your-username/your-repo --issue
export GITHUB_TOKEN=ghp_your_token_here
# Create issues for each problem found
-repo-doctor analyze your-username/your-repo --issue
+repocheck analyze your-username/your-repo --issue
# Result: One or multiple GitHub issues created automatically, depending on findings.
```
-#### Interactive Mode
+#### Web UI (equivalent to `--issue`)
```bash
-# Set token securely for the session
-export GITHUB_TOKEN=ghp_your_token_here
-
-# Then start interactive mode
-repo-doctor chat
-# Then type:
-/analyze facebook/react --issue
-/deep microsoft/vscode
+npm run dev:local-ui
```
----
-
-## 🧪 Testing Publishing Features
+In the Web UI form:
-Want to try the publishing features? Here's a complete step-by-step guide:
+1. Enable `Publish to GitHub Issues`
+2. Optional: fill `GitHub Token`
+3. Run analysis
-### Step 1: Get Your GitHub Token
+If `GitHub Token` is empty, the backend uses `GITHUB_TOKEN` from the server environment.
-1. **Go to GitHub Settings**
- - Visit [github.com](https://github.com) → Your profile → **Settings**
-
-2. **Generate Personal Access Token**
- - **Developer settings** → **Personal access tokens** → **Tokens (classic)**
- - Click **"Generate new token (classic)"**
- - **Name**: `Repo Doctor Test`
- - **Expiration**: 7 days (for testing)
- - **Scopes**: Select one of these options:
- - `repo` (full control of private repositories) **OR**
- - Granular permissions:
- - `metadata` — Read repository metadata
- - `contents` — Read repository contents
- - `issues` — Create and manage issues
-
-3. **Copy the token** (often starts with `ghp_` or `github_pat_`)
-
-### Step 2: Test with Interactive Mode
+#### Interactive Mode
```bash
-# Set your token securely
+# Set token securely for the session
export GITHUB_TOKEN=ghp_your_token_here
-# Start interactive mode
-repo-doctor chat
-```
-
-### Step 3: Test Issue Creation
-
-```bash
-# In the chat, type:
+# Then start interactive mode
+repocheck chat
+# Then type:
/analyze facebook/react --issue
+/deep microsoft/vscode
```
-**What happens:**
-- ✅ Analyzes the repository
-- ✅ Creates a GitHub issue in `facebook/react` (if you have access)
-- ✅ Or creates issues in your own repository if you don't have access to facebook/react
-
-### Step 4: Test with Your Own Repository
-
-```bash
-# Use your own repository for testing
-/analyze your-username/your-repo --issue
-```
-
-**Expected Result:**
-- One or multiple issues created, depending on findings
-- Each issue has detailed description, impact, and fix instructions
-- Issues are labeled by category (docs, dx, ci, security, etc.)
-
-### Example Output
-
-After running `/analyze facebook/react --issue`, you should see:
-
-```
-✓ Analysis completed successfully!
- Made 25 API calls in 45.2s
-
- Publishing report as GitHub issue(s)...
-
-✓ Report published: 3 issues created.
- https://github.com/facebook/react/issues/123
- https://github.com/facebook/react/issues/124
- https://github.com/facebook/react/issues/125
-```
-
-### Troubleshooting Publishing
+---
-**"Repository not found"**
-- Check repository name spelling
-- Ensure you have access to the repository
-- Try with your own repository first
+## 🧪 Testing Publishing Features
-**"Token permission denied"**
-- Regenerate token with correct scopes
-- Make sure you have `repo` scope OR the granular permissions: `metadata`, `contents`, and `issues`
+Quick validation checklist:
-**"No issues created"**
-- The repository might be very healthy (no issues found)
-- Check the analysis output for problems
+1. Configure token with issue-write permission.
+2. Run one CLI test (`repocheck analyze owner/repo --issue`) or one Web UI test (`npm run dev:local-ui` + enable `Publish to GitHub Issues`).
+3. Confirm new issue(s) were created in the target repository.
-### Security Best Practices
+If publishing fails:
+- `401` in model listing: Copilot auth issue (`GH_TOKEN` path).
+- `401/403` in issue creation: GitHub API token scope/access issue (`GITHUB_TOKEN` path).
-- **Never commit tokens** to code
-- Use short-lived tokens for testing
-- Revoke tokens after testing
-- Consider GitHub Apps for production use
-
----
+For full step-by-step setup, token scope matrix, and troubleshooting, use:
+- [Issue Publishing Guide](issue-publishing.md)
---
@@ -450,11 +384,11 @@ Now that you've run your first analysis:
```bash
# Your organization's repos
-repo-doctor your-org/your-repo
+repocheck your-org/your-repo
# Private repositories (requires token)
export GITHUB_TOKEN=ghp_xxxxx
-repo-doctor your-org/private-repo
+repocheck your-org/private-repo
```
### Publishing Features
@@ -465,10 +399,10 @@ With a GitHub Personal Access Token, you can automatically publish analysis repo
```bash
# Create a GitHub issue with the complete analysis
-GITHUB_TOKEN=ghp_your_token repo-doctor analyze owner/repo --issue
+GITHUB_TOKEN=ghp_your_token repocheck analyze owner/repo --issue
# The issue includes:
-# - Title: "Repo Doctor Report: owner/repo"
+# - Title: "RepoCheckAI Report: owner/repo"
# - Labels: Based on findings (docs, dx, ci, security, etc.)
# - Body: Full analysis report in Markdown format
```
@@ -476,7 +410,7 @@ GITHUB_TOKEN=ghp_your_token repo-doctor analyze owner/repo --issue
#### Interactive Mode
```bash
-repo-doctor chat
+repocheck chat
# Then use:
/analyze owner/repo --issue
/deep owner/repo
@@ -484,7 +418,7 @@ repo-doctor chat
### Integrate into Workflow
-- Run Repo Doctor before major releases
+- Run RepoCheckAI before major releases
- Use it in CI/CD for automated health checks
- Share reports with your team
- **Auto-publish issues** for tracking repository improvements
@@ -492,26 +426,26 @@ repo-doctor chat
### Join the Community
-- ⭐ [Star the repository](https://github.com/glaucia86/repo-doctor)
-- 🐛 [Report issues](https://github.com/glaucia86/repo-doctor/issues)
-- 💡 [Suggest features](https://github.com/glaucia86/repo-doctor/discussions)
+- ⭐ [Star the repository](https://github.com/glaucia86/repocheckai)
+- 🐛 [Report issues](https://github.com/glaucia86/repocheckai/issues)
+- 💡 [Suggest features](https://github.com/glaucia86/repocheckai/discussions)
- 🤝 [Contribute](CONTRIBUTING.md)
---
## Troubleshooting Installation
-### "command not found: repo-doctor"
+### "command not found: repocheck"
The global link wasn't created properly:
```bash
# Try relinking
-npm unlink repo-doctor
+npm unlink repocheck
npm link
# Or run directly
-npx repo-doctor
+npx repocheck
```
### "Cannot find module" errors
@@ -544,3 +478,6 @@ See [Troubleshooting](troubleshooting.md) for more solutions.
← Back to Documentation •
User Guide →
AI-powered GitHub Repository Health Analyzer
@@ -6,11 +6,21 @@
---
-Welcome to the official documentation for **Repo Doctor** — an agentic CLI tool that performs comprehensive health checks on GitHub repositories using AI.
+Welcome to the official documentation for **RepoCheckAI** — an agentic CLI tool that performs comprehensive health checks on GitHub repositories using AI.
-## What is Repo Doctor?
+## Recommended Path For Issue Publishing
-Repo Doctor is your repository's AI doctor that diagnoses issues and prescribes solutions. Built with the [GitHub Copilot SDK](https://github.com/github/copilot-sdk), it analyzes repositories across **6 critical areas**:
+If your goal is to publish analysis results as GitHub issues, follow this order:
+
+1. Read [🧭 Issue Publishing](issue-publishing.md) for token/auth setup and troubleshooting.
+2. Choose your interface:
+ - CLI: use `--issue`
+ - Web UI: enable `Publish to GitHub Issues`
+3. If publishing fails with `401/403`, return to the same guide and follow the diagnostics section.
+
+## What is RepoCheckAI?
+
+RepoCheckAI is your repository's AI doctor that diagnoses issues and prescribes solutions. Built with the [GitHub Copilot SDK](https://github.com/github/copilot-sdk), it analyzes repositories across **6 critical areas**:
- 📚 **Documentation & Onboarding**
- ⚡ **Developer Experience**
@@ -93,14 +103,14 @@ Get an overall health percentage (0-100%) based on weighted category scores:
```bash
# Install
-git clone https://github.com/glaucia86/repo-doctor.git
-cd repo-doctor && npm install && npm run build && npm link
+git clone https://github.com/glaucia86/repocheckai.git
+cd repocheckai && npm install && npm run build && npm link
# Run interactive mode
-repo-doctor
+repocheck
# Or analyze directly
-repo-doctor vercel/next.js
+repocheck vercel/next.js
```
See the [Getting Started Guide](getting-started.md) for detailed instructions.
@@ -119,8 +129,8 @@ See the [Getting Started Guide](getting-started.md) for detailed instructions.
## Support
-- 🐛 **Found a bug?** [Open an issue](https://github.com/glaucia86/repo-doctor/issues/new)
-- 💡 **Have an idea?** [Start a discussion](https://github.com/glaucia86/repo-doctor/discussions)
+- 🐛 **Found a bug?** [Open an issue](https://github.com/glaucia86/repocheckai/issues/new)
+- 💡 **Have an idea?** [Start a discussion](https://github.com/glaucia86/repocheckai/discussions)
- 🤝 **Want to contribute?** Read our [Contributing Guide](CONTRIBUTING.md)
---
@@ -128,3 +138,5 @@ See the [Getting Started Guide](getting-started.md) for detailed instructions.
+
+
diff --git a/docs/issue-publishing.md b/docs/issue-publishing.md
index 7cfe673..8f51d9a 100644
--- a/docs/issue-publishing.md
+++ b/docs/issue-publishing.md
@@ -6,7 +6,7 @@ This guide explains how to use the `--issue` flag safely, how Copilot SDK auth d
## 1) Two auth paths (very important)
-Repo Doctor uses two separate auth paths:
+RepoCheckAI uses two separate auth paths:
- **Copilot SDK auth (models and analysis)**
- If this fails, you will see: `Failed to list models: 401`.
@@ -37,7 +37,7 @@ gh auth login
# Do NOT use GITHUB_TOKEN here
gh auth status
-# Export OAuth token for Repo Doctor
+# Export OAuth token for RepoCheckAI
$env:GH_TOKEN = (gh auth token)
```
@@ -74,7 +74,7 @@ You need a PAT that can create issues in the target repo.
---
-## 4) Run Repo Doctor with `--issue`
+## 4) Run RepoCheckAI with `--issue` (CLI)
You can use Copilot auth (GH_TOKEN) and pass the PAT only for issue creation.
@@ -95,12 +95,34 @@ In the app:
Direct mode:
```powershell
-repo-doctor analyze owner/repo --issue --token
+repocheck analyze owner/repo --issue --token
```
---
-## 5) Quick diagnostics
+## 5) Run issue publishing from Web UI
+
+Start both services:
+
+```bash
+npm run dev:local-ui
+```
+
+In the Web UI form:
+
+1. Enable **Publish to GitHub Issues**
+2. Optionally fill **GitHub Token**
+3. Run analysis
+
+Token behavior in Web UI:
+
+- If **GitHub Token** is filled, that value is used.
+- If the field is empty, the backend tries `GITHUB_TOKEN` from server environment.
+- If neither is available, analysis still runs, but issue publishing is skipped.
+
+---
+
+## 6) Quick diagnostics
### Check PAT can create an issue
@@ -109,7 +131,7 @@ $env:GITHUB_TOKEN = ""
Invoke-RestMethod -Method Post \
-Headers @{ Authorization = "Bearer $env:GITHUB_TOKEN" } \
-Uri https://api.github.com/repos/owner/repo/issues \
- -Body (@{ title = "Repo Doctor test"; body = "test" } | ConvertTo-Json) \
+ -Body (@{ title = "RepoCheckAI test"; body = "test" } | ConvertTo-Json) \
-ContentType "application/json"
```
@@ -121,7 +143,7 @@ Invoke-RestMethod -Method Post \
---
-## 6) Security notes
+## 7) Security notes
- Never commit tokens or store them inside the repo
- Use short expiration for PATs
@@ -132,3 +154,5 @@ Invoke-RestMethod -Method Post \