Skip to content

Latest commit

 

History

History
190 lines (132 loc) · 5.49 KB

README.md

File metadata and controls

190 lines (132 loc) · 5.49 KB
Raw

Kondo 🧹

Cleans node_modules, target, build, and friends from your projects.

Excellent if

  • 💾 You want to back up your code but don't want to include GBs of dependencies
  • 🧑‍🎨 You try out lots of projects but hate how much space they occupy
  • ⚡️ You like keeping your disks lean and zippy

20+ Supported Project Types

Cargo (Rust), CMake (C, C++), Composer (PHP), Elixir, Godot 4.x (C#, GDScript)

Gradle (Java) Jupyter Notebook (Python), Pixi (Python), Maven (Java), Node (JavaScript)

Pub (Dart), Python SBT (Scala), Stack (Haskell), Cabal (Haskell), Swift

Unity (C#), Unreal Engine (C++), Zig, .NET (C#, F#) Turborepo (JavaScript)

kondo cli cleaning projects

kondo gui displaying projects

CLI Video
kondo-cli-preview-clean.webm
GUI Video
kondo-ui.webm

Installation

Warning

Kondo is essentially rm -rf with a prompt. Use at your own discretion. Always have a backup of your projects.

Command Line

winget

winget install kondo

Homebrew

brew install kondo

MacPorts

sudo port install kondo

Arch Linux

pacman -S kondo

Source

Requires Rust.

git clone https://github.com/tbillington/kondo.git
cargo install --path kondo/kondo

Others

Binaries available on the releases page.

Packaging status

Graphic User Interface

Windows

winget install kondo-ui

Arch Linux

pacman -S kondo-ui

Source

Requires rust. You may need platform specific dependencies on linux.

git clone https://github.com/tbillington/kondo.git
cargo install --path kondo/kondo-ui

Binaries available on the releases page.

Packaging status

Usage

Warning

Kondo is essentially rm -rf with a prompt. Use at your own discretion. Always have a backup of your projects.

Command Line Interface

Running kondo without a directory specified will run in the current directory.

kondo

Supplying a path will tell kondo where to start. Multiple paths are supported.

kondo code/my_project code/my_project_2

Passing a time will filter projects to those that haven't been modified for at least the specified period. See kondo --help for the full list of options.

kondo --older 3M # only projects with last modified greater than 3 months
kondo -o3M # shorthand

More options such as quiet mode, following symlinks, and filesystem restriction are viewable with kondo --help.

Building/Development

To build the cli kondo you can run cargo build and cargo run from the projects root directory.

To build the gui kondo-ui you must first navigate into the kondo-ui directory, then you can run cargo build and cargo run.

The output binaries will be located in target/debug/ or target/release/ per Cargo defaults.

Similar Projects