crossoverJiecrossoverJie/cim/CLAUDE.md

cim

CLAUDE.md9.5k starsChanged 2 years agoMITView on GitHub

CIM (Cross-platform Instant Messaging) is a Java-based instant messaging framework. Before running compile or test commands, set the correct JDK version: JAVA_17_HOME is defined in ~/.zshrc.

The file

We split this CLAUDE.md into the rules it gives an agent

2 rules. About 0 are common, 2 are distinctive, and 0 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈2
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Before running compile or test commands, set the correct JDK version:
line 13
Distinctive:
Ensure code passes Checkstyle checks before committing
line 46

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

CLAUDE.md

CIM Project Guide

CIM (Cross-platform Instant Messaging) is a Java-based instant messaging framework.

Requirements

Minimum JDK Version: JDK 17
Build Tool: Maven
Spring Boot Version: 3.3.0

Environment Setup

Before running compile or test commands, set the correct JDK version:

export JAVA_HOME=$JAVA_17_HOME

JAVA_17_HOME is defined in ~/.zshrc.

Common Commands

Compile the project

mvn clean compile

Run tests

mvn test

Package the project

mvn clean package -DskipTests

Full build (with tests)

mvn clean install

Notes

Checkstyle code style checks run automatically during Maven's validate phase
Ensure code passes Checkstyle checks before committing

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free

cim

Trending

Who's talking about crossoverJie/cim