Skip to content

🐾 Codecat v1.1.0: All-New Web UI & Offline Mode

Latest
Latest

Choose a tag to compare

View all tags
@Exonymos Exonymos released this 08 Mar 02:03
v1.1.0
f58fff8
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Heya everyone! 👋

This is a major feature update for Codecat! Introducing a completely new Web UI, bringing a visual, interactive way to use Codecat right in your browser. This release also includes fully offline support for the web interface and various bug fixes and improvements under the hood.

✨ What's New in v1.1.0

  • 🌐 Brand New Web UI: A completely new feature! The codecat web interface provides a sleek, responsive, and easy-to-use visual dashboard that perfectly reflects the CLI's capabilities.
  • 🔌 Fully Offline Functionality: You can run the web interface completely disconnected from the internet! All local assets (CSS/JS) are bundled.
  • 🛠️ Bug Fixes & Improvements: Addressed various minor bugs, improved overall code quality and reliability, fixed tooling configuration (Black, flake8, pyright), and raised test coverage

🚀 How to Use It

Warning

A Note for Windows Users: Windows Defender or other antivirus software might flag the .exe as a potential threat. This is a common false positive for applications built with PyInstaller. The executable is safe to run - the entire build process is transparent and run via GitHub Actions.
You may need to click "More info" -> "Run anyway" to proceed. To avoid this in the future, you can add codecat.exe to your antivirus exclusion list.

  1. Download the executable for your OS from the Assets below.

  2. Make it easy to run from anywhere by adding it to your PATH:

    • For Windows:

      • Rename codecat-windows.exe to just codecat.exe.
      • Move it to a permanent folder (e.g., C:\Tools).
      • Add that folder to your system's PATH environment variable.

    • For Linux:

      # Make the file executable and move it to a common PATH location
chmod +x codecat-linux
sudo mv codecat-linux /usr/local/bin/codecat

  3. Now, you can run it from any project folder in your terminal!

    # Scan your project and create the Markdown file
codecat run .

# Or, get quick stats about your code
codecat stats .

# Or, try the new web interface
codecat web

For more details, check out the README!

Thanks for your support and for reporting issues! Enjoy the update.

Assets 4
Loading