Skip to content

docs: Add repo assessment, commands reference, and evaluation docs#986

Merged
affaan-m merged 5 commits intoaffaan-m:mainfrom
Infiniteyieldai:claude/evaluate-repo-comparison-ASZ9Y
Mar 29, 2026
Merged

docs: Add repo assessment, commands reference, and evaluation docs#986
affaan-m merged 5 commits intoaffaan-m:mainfrom
Infiniteyieldai:claude/evaluate-repo-comparison-ASZ9Y

Conversation

@Infiniteyieldai
Copy link
Copy Markdown

@Infiniteyieldai Infiniteyieldai commented Mar 28, 2026

What Changed

Added three comprehensive documentation files to guide setup and usage of the everything-claude-code repository:

  1. REPO-ASSESSMENT.md — Complete fork health check, available components inventory (28 agents, 116 skills, 59 commands, 60+ rules), and five install profiles (core, developer, security, research, full) with setup recommendations
  2. COMMANDS-QUICK-REF.md — Quick reference guide for all 59 slash commands organized by workflow category (core, testing, code review, build fixers, planning, session management, learning, refactoring, docs, loops, project infrastructure)
  3. EVALUATION.md — Gap analysis comparing current minimal setup (1 hook, 0 agents/skills/commands) against the full repo capabilities, with prioritized recommendations for immediate value
  4. .claude/rules/node.md — Project-specific Node.js coding standards for the ECC codebase (CommonJS, file conventions, hook development patterns, testing requirements)

Why This Change

The repository provides a powerful toolkit (28 agents, 116 skills, 59 commands) but lacks clear guidance on:

  • Whether the fork is healthy and ready to use
  • Which components are available and what they do
  • How to choose an appropriate install profile
  • What the current setup is missing and what to prioritize
  • How to develop within the ECC codebase itself

These docs provide a clear onboarding path and reference material for both users installing ECC and contributors working on the codebase.

Testing Done

  • Manual testing completed — N/A (documentation only)
  • Automated tests pass locally — N/A (no code changes)
  • Edge cases considered — Documentation reviewed for accuracy against repo structure

Type of Change

  • docs: Documentation

Security & Quality Checklist

  • No secrets or API keys committed
  • JSON files validate cleanly (no JSON in these docs)
  • Markdown files follow project conventions (lowercase filenames, proper frontmatter where applicable)
  • No sensitive data exposed
  • Follows conventional commits format (docs: prefix)

Documentation

  • Added comprehensive setup and reference documentation
  • Included Node.js project-specific rules for contributors
  • All docs follow existing markdown conventions in the repo

https://claude.ai/code/session_014SqRA9y6HwVVPGeSCJfwVF


Summary by cubic

Adds repo assessment, commands quick reference, setup evaluation, and Node.js rules to streamline onboarding, workflows, and contributor standards. Documents fork health (synced to upstream v1.9.0) and provides install profiles with copy‑paste commands.

  • New Features
    • REPO-ASSESSMENT.md: Fork health (upstream v1.9.0), five install profiles (core/developer/security/research/full) with install-plan/install-apply steps, priority additions, and hook upgrades.
    • COMMANDS-QUICK-REF.md: 59 slash commands grouped by workflow plus a quick decision guide.
    • EVALUATION.md: Gap analysis of minimal ~/.claude/ (1 Stop hook) vs repo (28 agents, 116 skills, 59 commands) with install and rules recommendations.
    • .claude/rules/node.md: Project Node.js standards (Node ≥18, CommonJS, @eslint/js flat config, c8, markdownlint), file conventions, hook development via run-with-flags.js, and testing requirements.

Written for commit c865d4c. Summary will update on new commits.

Summary by CodeRabbit

  • Documentation
    • Added project conventions documenting Node.js runtime, packaging, testing, linting, naming and hook behaviours
    • Added Commands Quick Reference summarizing available commands and a decision guide for common workflows
    • Added an evaluation report comparing local setup to a full-featured reference with gap analysis and install recommendations
    • Added a repo assessment with install profiles, setup checklist, and recommended onboarding steps

Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@ecc-tools
Copy link
Copy Markdown
Contributor

ecc-tools bot commented Mar 28, 2026

Analyzing 5000 commits...

@ecc-tools
Copy link
Copy Markdown
Contributor

ecc-tools bot commented Mar 28, 2026

Analysis Failed

Not Found - https://docs.github.com/rest/git/refs#get-a-reference

Troubleshooting
Cause Resolution
Large repository Analysis may timeout on repos with extensive history
API rate limits Wait 15 minutes before retrying
Network issues Queue timeout is 15 minutes; retry may succeed
Permissions Verify app has Contents: Read access

Retry: /ecc-tools analyze


Report Issue | ECC Tools

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 28, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e603f463-2d54-43a9-a670-dd52a738ee7b

📥 Commits

Reviewing files that changed from the base of the PR and between a16c879 and c865d4c.

📒 Files selected for processing (4)
  • .claude/rules/node.md
  • COMMANDS-QUICK-REF.md
  • EVALUATION.md
  • REPO-ASSESSMENT.md

📝 Walkthrough

Walkthrough

Added four documentation files: Node.js project rules at .claude/rules/node.md, a commands quick reference, and two repository assessment/evaluation guides. All changes are documentation-only; no runtime or application code was modified.

Changes

Cohort / File(s) Summary
Node.js Project Rules
\.claude/rules/node.md
New project-specific rules: Node >=18, CommonJS-only conventions (with .mjs exception), test execution patterns, linting/coverage tooling (ESLint flat config, c8), markdown linting, file/naming conventions, code style (use const, no var), hook development constraints (stdin JSON patterns, run-with-flags.js, timeouts, blocking/no-network rules), and error/logging expectations.
Documentation — Commands & Assessment
COMMANDS-QUICK-REF.md, EVALUATION.md, REPO-ASSESSMENT.md
Adds a Commands Quick Reference grouped by functionality and a Quick Decision Guide; an evaluation comparing local setup to repo v1.9.0 with gap analysis and install recommendations; and a repo assessment with install profiles, recommended install commands, priority additions, and a setup checklist.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~4 minutes

Suggested reviewers

  • affaan-m

Poem

🐇 I nibbled through lines of rules and rhyme,

Collected commands in tidy time,
A checklist, an evaluation bright,
Node notes tucked in the evening light,
Hooray — the rabbit stamps it right! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title clearly summarizes the main changes: addition of three documentation files (repo assessment, commands reference, and evaluation docs) plus a node.js rules file, all of which are substantiated by the raw_summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 4 files

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.claude/rules/node.md:
- Line 33: Update the documentation line that incorrectly refers to
CLAUDE_ECC_MODE: replace that reference with the actual gating environment
variables used by the hook layer (ECC_HOOK_PROFILE and ECC_DISABLED_HOOKS) and
mention that run-with-flags.js uses ECC_HOOK_PROFILE (with ECC_DISABLED_HOOKS as
the disable list) to control hook enablement; update any surrounding text to
consistently reference ECC_HOOK_PROFILE and ECC_DISABLED_HOOKS so guidance
matches the actual gating implementation.
- Line 30: The rule incorrectly requires all hook scripts to read JSON from
stdin via fs.readFileSync(0), but hooks may instead be invoked through
run-with-flags.js which calls the exported run(rawInput) function; update the
doc/rule to allow both input patterns by removing the absolute "always"
statement and document that hook implementations should accept either reading
JSON from stdin or supporting an exported run(rawInput) entrypoint (reference
run-with-flags.js and the run(rawInput) export) so contributors can follow the
correct invocation pattern.

In `@EVALUATION.md`:
- Around line 44-45: Update the install profile names in the EVALUATION.md table
and example commands: change the table row labeled "Install profiles" to list
the actual supported profiles "core, developer, security, research, full" and
replace any example CLI usage of `ecc install --profile minimal` (and `--profile
standard`/`--profile enterprise` if present) with valid profiles such as `ecc
install --profile core` (or `developer`, `security`, `research`, `full`) so
examples match manifest-supported profiles and avoid "Unknown install profile"
errors.

In `@REPO-ASSESSMENT.md`:
- Line 171: Replace the hardcoded local path "/home/user/everything-claude-code"
in REPO-ASSESSMENT.md with a portable instruction such as "cd <path-to-clone>"
or "cd from your local repo root" so setup steps are not tied to a specific
user; update the single line containing that path to use a placeholder like
<path-to-clone> or wording "from your local repo root" for clarity and
portability.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fc6d2514-627b-405b-a3a4-a2b3be50c87e

📥 Commits

Reviewing files that changed from the base of the PR and between f077975 and a16c879.

📒 Files selected for processing (4)
  • .claude/rules/node.md
  • COMMANDS-QUICK-REF.md
  • EVALUATION.md
  • REPO-ASSESSMENT.md

Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@Infiniteyieldai
Copy link
Copy Markdown
Author

REPO-ASSESSMENT.md — Complete fork health check, available components inventory (28 agents, 116 skills, 59 commands, 60+ rules), and five install profiles (core, developer, security, research, full) with setup recommendations.

COMMANDS-QUICK-REF.md — Quick reference guide for all 59 slash commands organized by workflow category (core, testing, code review, build fixers, planning, session management, learning, refactoring, docs, loops, project infrastructure)

EVALUATION.md — Gap analysis comparing current minimal setup (1 hook, 0 agents/skills/commands) against the full repo capabilities, with prioritized recommendations for immediate value
.claude/rules/node.md — Project-specific Node.js coding standards for the ECC codebase (CommonJS, file conventions, hook development patterns, testing requirements)

Copy link
Copy Markdown
Author

@Infiniteyieldai Infiniteyieldai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approved

claude and others added 5 commits March 28, 2026 20:03
Compares everything-claude-code v1.9.0 against the minimal ~/.claude/ installation.
Documents gap analysis across agents, skills, commands, hooks, and rules.

https://claude.ai/code/session_014SqRA9y6HwVVPGeSCJfwVF
Covers fork health, gap analysis, install profile guidance, and priority
components to add to the current minimal ~/.claude/ setup.

https://claude.ai/code/session_014SqRA9y6HwVVPGeSCJfwVF
- Expand permissions.allow (git, node, npm, npx, ls, cat, Read, Edit, Write, Glob, Grep) to reduce approval prompts
- Set CLAUDE_ECC_MODE=standard in env for consistent hook profile
- Gate stop-hook-git-check.sh behind ECC_GIT_CHECK=1 to prevent blocking mid-session
- Add project-level Node.js rules for ECC repo (stack, file conventions, hook dev standards)
- observe.sh confirmed already async — no change needed

https://claude.ai/code/session_014SqRA9y6HwVVPGeSCJfwVF
@affaan-m affaan-m force-pushed the claude/evaluate-repo-comparison-ASZ9Y branch from a16c879 to c865d4c Compare March 29, 2026 00:03
@ecc-tools
Copy link
Copy Markdown
Contributor

ecc-tools bot commented Mar 29, 2026

Analyzing 5000 commits...

@ecc-tools
Copy link
Copy Markdown
Contributor

ecc-tools bot commented Mar 29, 2026

Analysis Failed

Not Found - https://docs.github.com/rest/git/refs#get-a-reference

Troubleshooting
Cause Resolution
Large repository Analysis may timeout on repos with extensive history
API rate limits Wait 15 minutes before retrying
Network issues Queue timeout is 15 minutes; retry may succeed
Permissions Verify app has Contents: Read access

Retry: /ecc-tools analyze


Report Issue | ECC Tools

@affaan-m affaan-m merged commit 64847d0 into affaan-m:main Mar 29, 2026
2 of 3 checks passed
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Mar 29, 2026

Greptile Summary

This PR adds four documentation files to improve onboarding and daily-use guidance for the everything-claude-code repository: a fork health assessment (REPO-ASSESSMENT.md), a 59-command quick reference (COMMANDS-QUICK-REF.md), a gap analysis against a minimal ~/.claude/ setup (EVALUATION.md), and project-specific Node.js coding rules for ECC contributors (.claude/rules/node.md). The additions are clearly structured and fill a real gap in the repo's documentation, but three files carry factual inaccuracies in their install commands and component counts that could cause user-facing failures.

Key findings:

  • Incorrect install command in EVALUATION.mdecc install --profile core/full maps ecc install to install-apply.js only; the --profile flag must be passed to the plan step (ecc plan --profile <name> && ecc install). This same error appears in both the core and full install blocks.
  • Invalid npm invocation in REPO-ASSESSMENT.mdnpx ecc-universal install is not a valid command; the package bin is named ecc, so the correct form is npx ecc plan --profile developer && npx ecc install.
  • Inconsistent component countsAGENTS.md (authoritative) reports 125 skills, 60 commands, and 14 MCP configs. All three new docs consistently report 116 skills, 59 commands, and 1 MCP config, which will mislead users.
  • Stale branch reference in EVALUATION.md — the ephemeral session branch claude/evaluate-repo-comparison-ASZ9Y is hard-coded in the document header.
  • Duplicate command entries in COMMANDS-QUICK-REF.md/tdd, /code-review, and /plan each appear in two sections without a cross-reference note.
  • .claude/rules/node.md is well-written and accurately reflects the project's conventions; no issues found there.

Confidence Score: 3/5

Not safe to merge as-is — two install commands are incorrect and will fail for users who follow them verbatim, and component counts conflict with the authoritative AGENTS.md throughout all three major docs.

There are three P1 findings: the ecc install --profile command in EVALUATION.md routes to the wrong script and skips the plan step; npx ecc-universal install in REPO-ASSESSMENT.md is not a valid binary name; and the skill/command/MCP counts are inconsistent with AGENTS.md across all three docs. These are documentation files, so there is no runtime risk, but they directly describe user-facing install steps that will produce incorrect behavior if followed.

EVALUATION.md (wrong install command, stale branch, stale counts) and REPO-ASSESSMENT.md (invalid npx command, stale counts) need fixes before merge. COMMANDS-QUICK-REF.md has minor duplicate-entry and count issues.

Important Files Changed

Filename Overview
EVALUATION.md Gap analysis doc with three correctness issues: stale session-branch in header, wrong ecc install --profile command (should be ecc plan + ecc install), and component counts that don't match AGENTS.md.
REPO-ASSESSMENT.md Fork assessment with two issues: npx ecc-universal install is not a valid bin name (should be npx ecc), and hard-coded star/fork counts will go stale quickly. Component counts also diverge from AGENTS.md.
COMMANDS-QUICK-REF.md Useful quick-reference guide; /tdd, /code-review, and /plan are each listed in two sections without explanation, and the header count (59) conflicts with AGENTS.md (60).
.claude/rules/node.md Well-written project-specific Node.js rules; content is accurate and consistent with CLAUDE.md conventions; no issues found.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User wants to install ECC] --> B{Choose install profile}
    B --> C[core: Minimal footprint]
    B --> D[developer: Recommended for daily dev]
    B --> E[security: Audits and vulnerability reviews]
    B --> F[research: Content and market research]
    B --> G[full: All agents and skills]
    C --> H[ecc plan --profile core]
    D --> I[ecc plan --profile developer]
    E --> J[ecc plan --profile security]
    F --> K[ecc plan --profile research]
    G --> L[ecc plan --profile full]
    H & I & J & K & L --> M[ecc install]
    M --> N[Optionally add language rules]
    N --> O[Enable MCP Context7]
    O --> P[Review hook additions]
Loading

Reviews (1): Last reviewed commit: "docs: fix ECC setup reference drift" | Re-trigger Greptile

# Repo Evaluation vs Current Setup

**Date:** 2026-03-21
**Branch:** `claude/evaluate-repo-comparison-ASZ9Y`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Stale session-branch reference should be removed

Line 4 hard-codes claude/evaluate-repo-comparison-ASZ9Y, which is the ephemeral branch from the AI session that generated this file. After this PR is merged that branch will not exist, making the doc look like an unfinished draft rather than reference material. The **Branch:** field adds no value for a documentation file committed to main.

Suggested change
**Branch:** `claude/evaluate-repo-comparison-ASZ9Y`
**Branch:** `main`

Comment on lines +92 to +98
Run `ecc install --profile core` to get:
- Core agents (code-reviewer, planner, tdd-guide, security-reviewer)
- Essential skills (tdd-workflow, coding-standards, security-review)
- Key commands (/tdd, /plan, /code-review, /build-fix)

### Full install
Run `ecc install --profile full` to get all 28 agents, 116 skills, and 59 commands.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 ecc install --profile routes to the wrong script

ecc install is mapped to install-apply.js in scripts/ecc.js (line 9). The --profile flag belongs to the plan step (install-plan.js / ecc plan), not the apply step. A user who runs ecc install --profile core verbatim will skip the planning step and likely end up with nothing installed (or the apply script will error because no plan file exists yet).

The correct two-step invocation, consistent with REPO-ASSESSMENT.md and CLAUDE.md, is:

ecc plan --profile core
ecc install

The same problem applies to the full-profile block (ecc install --profile full on line 98).

Suggested change
Run `ecc install --profile core` to get:
- Core agents (code-reviewer, planner, tdd-guide, security-reviewer)
- Essential skills (tdd-workflow, coding-standards, security-review)
- Key commands (/tdd, /plan, /code-review, /build-fix)
### Full install
Run `ecc install --profile full` to get all 28 agents, 116 skills, and 59 commands.
Run `ecc plan --profile core && ecc install` to get:

Comment on lines +33 to +45
| Component | Repo |
|-----------|------|
| Agents | 28 |
| Skills | 116 |
| Commands | 59 |
| Rules sets | 12 languages + common (60+ rule files) |
| Hooks | Comprehensive system (PreToolUse, PostToolUse, SessionStart, Stop) |
| MCP configs | 1 (Context7 + others) |
| Schemas | 9 JSON validators |
| Scripts/CLI | 46+ Node.js modules + multiple CLIs |
| Tests | 58 test files |
| Install profiles | core, developer, security, research, full |
| Supported harnesses | Claude Code, Codex, Cursor, OpenCode |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Component counts differ from the authoritative AGENTS.md

AGENTS.md (the canonical reference file) states 125 skills, 60 commands, and 14 MCP server configurations. This file (and REPO-ASSESSMENT.md) report 116 skills, 59 commands, and 1 MCP config, which will mislead users trying to understand the scope of the repository.

The same discrepancy appears in REPO-ASSESSMENT.md (lines 29–35) and the COMMANDS-QUICK-REF.md header ("59 slash commands"). Please reconcile with AGENTS.md before merging so all three docs tell a consistent story.

Comment on lines +1 to +3
# Commands Quick Reference

> 59 slash commands installed globally. Type `/` in any Claude Code session to invoke.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Header count and duplicate entries are inconsistent

The header claims "59 slash commands", but AGENTS.md says 60. More concretely, /tdd appears in both Core Workflow (line 14) and Testing (line 25), /code-review in both Core Workflow (line 16) and Code Review (line 38), and /plan in both Core Workflow (line 13) and Planning & Architecture (line 59). Each duplicate inflates the apparent command count without adding information.

Consider either (a) removing the duplicates from "Core Workflow" and keeping them only in their category section, or (b) adding a note like (see Testing) to make the cross-listing intentional and clear.


### Repo: `Infiniteyieldai/everything-claude-code`

This is a **fork of `affaan-m/everything-claude-code`** (the upstream project with 50K+ stars, 6K+ forks).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Hard-coded star/fork counts will become stale immediately

"50K+ stars, 6K+ forks" is a point-in-time claim. These numbers will be outdated within days and may already be inaccurate. If the goal is to convey that the upstream is popular, a vaguer phrase like "a widely-adopted upstream project" is more durable. If the exact figures are desired, link to the GitHub page instead of hard-coding them.

Comment on lines +160 to +164
### Option C: Install from npm (simplest for fresh machines)
```bash
npx ecc-universal install --profile developer
```
No need to clone the repo. This is the recommended install method for most users.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 npx ecc-universal install is not a valid command

The package.json bin map exposes ecc (→ scripts/ecc.js), not ecc-universal. The correct install-from-npm invocation is npx ecc install, not npx ecc-universal install. Running the command as written will fail with "unknown command" for users who try the npm path.

Suggested change
### Option C: Install from npm (simplest for fresh machines)
```bash
npx ecc-universal install --profile developer
```
No need to clone the repo. This is the recommended install method for most users.
```bash
npx ecc plan --profile developer
npx ecc install

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants