Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tbillington/kondo
Cleans dependencies and build artifacts from your projects.
https://github.com/tbillington/kondo
cargo cleaner cli command-line disk-space gui kondo linux macos rust unity unity3d windows
Last synced: 23 days ago
JSON representation
Cleans dependencies and build artifacts from your projects.
- Host: GitHub
- URL: https://github.com/tbillington/kondo
- Owner: tbillington
- License: mit
- Created: 2020-01-27T03:57:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T04:29:04.000Z (about 1 month ago)
- Last Synced: 2024-09-30T18:02:10.228Z (about 1 month ago)
- Topics: cargo, cleaner, cli, command-line, disk-space, gui, kondo, linux, macos, rust, unity, unity3d, windows
- Language: Rust
- Homepage:
- Size: 383 KB
- Stars: 1,766
- Watchers: 12
- Forks: 51
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-tools - tbillington/kondo - Save disk space by cleaning non-essential files from software projects. (Command Line / Dependency Management)
- awesome-rust - Kondo - CLI & GUI tool for deleting software project artifacts and reclaiming disk space (Applications / System tools)
- awesome-rust-cn - Kondo - 用于删除软件项目工件和回收磁盘空间的CLI和GUI工具 (应用程序 Applications / 系统工具 System tools)
- awesome-rust - Kondo - CLI & GUI tool for deleting software project artifacts and reclaiming disk space (Applications / System tools)
- my-awesome - tbillington/kondo - line,disk-space,gui,kondo,linux,macos,rust,unity,unity3d,windows pushed_at:2024-10 star:1.8k fork:0.1k Cleans dependencies and build artifacts from your projects. (Rust)
- awesome-ops - tbillington/kondo - 01-27|2024-09-23 | 清理项目中的依赖关系和构建制品。 | (终端命令行工具)
- jimsghstars - tbillington/kondo - Cleans dependencies and build artifacts from your projects. (Rust)
- fucking-awesome-rust - Kondo - CLI & GUI tool for deleting software project artifacts and reclaiming disk space (Applications / System tools)
- fucking-awesome-rust - Kondo - CLI & GUI tool for deleting software project artifacts and reclaiming disk space (Applications / System tools)
README
# 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),
Swift
Unity (C#),
Unreal Engine (C++),
Zig,
.NET (C#, F#)
Turborepo (JavaScript)
CLI Video
[kondo-cli.webm](https://user-images.githubusercontent.com/2771466/222949617-0ed621bc-ac4e-495a-9165-036a3a597d34.webm)
GUI Video
[kondo-ui.webm](https://user-images.githubusercontent.com/2771466/222951044-13484711-6107-45d4-aaa3-3140bbbba898.webm)
## Installation
> **Warning**
>
> Kondo is [_essentially_](https://github.com/tbillington/kondo/blob/a7af95484d364bbb12eb3b40b0d860424dd1b714/kondo-lib/src/lib.rs#L236) `rm -rf` with a prompt. Use at your own discretion. Always have a backup of your projects.
### Command Line
**winget**
```powershell
winget install kondo
```
**Homebrew**
```sh
brew install kondo
```
**MacPorts**
```sh
sudo port install kondo
```
**Arch Linux**
```sh
pacman -S kondo
```
**Source**
Requires [Rust](https://www.rust-lang.org/tools/install).
```sh
git clone https://github.com/tbillington/kondo.git
cargo install --path kondo/kondo
```
**Others**
Binaries available on the [releases page](https://github.com/tbillington/kondo/releases).
### Graphic User Interface
**Windows**
```powershell
winget install kondo-ui
```
**Arch Linux**
```sh
pacman -S kondo-ui
```
**Source**
Requires [rust](https://www.rust-lang.org/tools/install). You may need [platform specific dependencies on linux](https://github.com/xi-editor/druid#platform-notes).
```sh
git clone https://github.com/tbillington/kondo.git
cargo install --path kondo/kondo-ui
```
Binaries available on the [releases page](https://github.com/tbillington/kondo/releases).
## Usage
> **Warning**
>
> Kondo is [_essentially_](https://github.com/tbillington/kondo/blob/a7af95484d364bbb12eb3b40b0d860424dd1b714/kondo-lib/src/lib.rs#L236) `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.
```sh
kondo
```
Supplying a path will tell `kondo` where to start. Multiple paths are supported.
```sh
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.
```sh
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](https://doc.rust-lang.org/cargo/index.html) defaults.
## Similar Projects
- [The Tin Summer](https://github.com/vmchale/tin-summer)
- [Detox](https://github.com/whitfin/detox)
- [Sweep](https://github.com/woubuc/sweep)
- [npkill](https://github.com/voidcosmos/npkill)
- [Cargo Cleanall](https://github.com/LeSnake04/cargo-cleanall)
- [Cargo Sweep](https://github.com/holmgr/cargo-sweep)
- [Cargo Wipe](https://github.com/mihai-dinculescu/cargo-wipe)
- [cargo-clean-recursive](https://github.com/IgaguriMK/cargo-clean-recursive)