8000 GitHub - ToyB0x/ai-lint: A document linting tool by AI. This is an experimental project that I am exploring AI, so there may be better tools out there.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
/ ai-lint Public

A document linting tool by AI. This is an experimental project that I am exploring AI, so there may be better tools out there.

License

Notifications You must be signed in to change notification settings

ToyB0x/ai-lint

Repository files navigation

AI-Lint: Comprehensive AI Behavior Control Platform

License

Control AI Behavior Across Your Entire Development Ecosystem

For detailed usage and rule configuration, please visit our official documentation

https://ai-lint.com/

Overview

AI-Lint is a comprehensive platform for controlling AI behavior through rules loaded from a Rule Registry. While traditional linters focus solely on code quality, AI-Lint extends this concept to your entire development ecosystem - from code and documentation to development workflows and LLM interactions.

AI conforms to your standards, not the other way around. Define rules that reflect your organization's style, structure, and requirements across all aspects of development. Whether you're creating documentation, optimizing workflows, or customizing LLM behavior, AI-Lint ensures consistency and quality throughout your development process.

Key Features

AI-Lint transforms how teams work with AI across four key areas:

AI Behavior Control

  • Flexible Rule System: Create, share, and extend rules for all aspects of development
  • Rule Registry: Load rules from local files or remote repositories with version control
  • MCP Server Integration: Seamless integration with AI tools

Documentation Excellence

  • Documentation Standards: Define and enforce consistent documentation practices
  • Auto-Fix Capability: Automatically fix documentation issues

Development Workflow Enhancement

  • Workflow Optimization: Create rules with LLM assistance for better development workflows
  • Cross-Team Collaboration: Involve PO/PdM/Business teams in rule creation

LLM Interaction Improvement

  • Behavior Customization: Tailor AI outputs to match your organization's specific needs

Quick Start

# Clone the repository
git clone https://github.com/ToyB0x/ai-lint.git
cd ai-lint

# Install dependencies and build
pnpm install && pnpm build

Add to your MCP server configuration file (adjust the path to your installation):

{
  "mcpServers": {
    "@ai-lint/mcp": {
      "command": "node",
      "args": ["/PATH/TO/YOUR_DIR/ai-lint/apps/mcp/dist/index.js"],
      "autoApprove": [],
      "disabled": false
    }
  }
}

🔍 For more detailed information, check our official documentation 🔍

Basic Usage

  1. Create a .clinerules file in your project root:
You (AI assistants like Cline or Roo Code) must follow these important rules:

- Verify that the MCP Server @ai-lint/mcp is properly set up
- If not set up correctly, inform the user "The @ai-lint/mcp configuration is incorrect" and halt all subsequent processing
- If set up correctly, execute @ai-lint/mcp's load-remote-act-rule and apply the following rules
  1. Restart your AI assistant to ensure it recognizes the new MCP server and rules.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

  • 2025/03/25: [Improved] Simplified README and added links to official documentation site
  • 2025/03/25: [Improved] Enhanced README with comprehensive documentation and examples
  • 2025/03/25: Initial creation

About

A document linting tool by AI. This is an experimental project that I am exploring AI, so there may be better tools out there.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  
0