Skip to main content

Welcome to CodeCleaner AI Docs

Welcome

Hello and welcome to the official documentation for CodeCleaner AI!

CodeCleaner AI is your AI-powered programming mentor. It helps everyone, from beginners to experts, write production-grade code, learn as they build, and debug faster through interactive chats. It’s like having a senior engineer by your side—24/7!

This documentation is your comprehensive guide to understanding and mastering the platform. Whether you're using CodeCleaner AI for the first time or wish to master its advanced features, this is the place to be.

About CodeCleaner AI:

CodeCleaner AI was built to code WITH you!

CodeCleaner AI is designed to be a crane: a tool that you control to lift much heavier things, not a black-box robot that will do everything for you. We believe in keeping a Human-in-the-Loop.

You, the developer, retain full control and make the important architectural decisions.

CodeCleaner AI acts as your trusted partner, providing expert suggestions, clear explanations, and a safety net to help you reduce technical debt and improve code quality.

Who These Docs Are For

CodeCleaner AI is built to empower every developer. We've designed these docs with specific roles in mind:

  • For Beginners: If you're learning to code, start with our Getting Started guides. We'll show you how to set up CodeCleaner AI, test that everything is working as expected and help you understand important Key Concepts.

  • For Experienced Developers: If you're a professional developer, you'll want to dive into our How-To Guides. Learn how to use CodeCleaner AI as an intelligent pair-programmer to accelerate debugging, master legacy code, and get a "second opinion" on complex problems.

  • For Expert Developers & Reviewers: If you lead teams or manage code quality, explore our guides on advanced functionalities.

How to Use These Docs

We've organized the documentation into several key sections to help you find what you need quickly:

  • 🚀 Getting Started: This section provides a step-by-step walkthrough, from creating your account to running your first analysis. It's the best place to begin your journey.
  • 🧠 Key Concepts: Learn about the fundamental building blocks of CodeCleaner AI, such as Projects, Sessions, Actions, Followup Actions. Understanding these concepts will help you unlock the full power of CodeCleaner AI.
  • COMING SOON - 🛠️ How-To Guides: Practical recipes for common tasks like debugging code, adding comments, fixing logical errors, and more.

Ready to Dive In?

Here are two great ways to get started right now:

  1. Start Building: Jump right into our first guide:

    🚀 Getting Started

  2. Join the Community: Have a question or want to connect with other developers? Our Discord server is the heart of the CodeCleaner AI community.

    💬 Join our Discord Server

We're excited to help you create, clean, and perfect code with CodeCleaner AI!