compi

Crates.io	compi
lib.rs	compi
version	0.5.2
created_at	2025-06-02 21:31:21.263349+00
updated_at	2025-12-17 21:25:12.352097+00
description	A build system written in Rust.
homepage	https://github.com/Allyedge/compi
repository	https://github.com/allyedge/compi
max_upload_size
id	1698398
size	76,000

Allyedge (Allyedge)

documentation

README

Compi

GitHub License Crates.io Total Downloads

A build system written in Rust.

Features

Clean TOML structure: Simple and declarative task definitions.
Incremental Builds: Tracks file hashes and modification times to skip unnecessary work.
Dependencies: Automatic DAG resolution for complex build chains.
Parallel Execution: Concurrent execution of independent tasks.

Installation

From crates.io

cargo install compi

From GitHub

cargo install --git https://github.com/allyedge/compi

From Source

git clone https://github.com/allyedge/compi
cd compi
cargo install --path .

From GitHub Releases

Download the latest binary for your platform from the GitHub Releases page.

Linux

wget https://github.com/allyedge/compi/releases/latest/download/compi-linux
chmod +x compi-linux
sudo mv compi-linux /usr/local/bin/compi

macOS

wget https://github.com/allyedge/compi/releases/latest/download/compi-macos
chmod +x compi-macos
sudo mv compi-macos /usr/local/bin/compi

Windows

Download the executable from the releases page and add it to your PATH.

CLI Usage

Flag	Description
`-f, --file <FILE>`	Configuration file (default: `compi.toml`)
`-j, --workers <N>`	Number of parallel workers (default: CPU cores)
`-t, --timeout <DURATION>`	Default timeout (e.g., "30s", "5m")
`--output <MODE>`	Output mode: `group` (default) or `stream`
`--dry-run`	Preview execution order without running tasks
`--rm`	Remove output files after successful execution
`-v, --verbose`	Enable verbose logging

compi
compi build
compi -j 8 build
compi -t 5m test
compi --rm build

Configuration Reference

Create a compi.toml in your project root.

[config]
default = "build"
cache_dir = ".compi_cache"
workers = 4
default_timeout = "10m"
output = "group"

[variables]
TARGET = "target"
SRC = "src/**/*.rs"
FLAGS = "--release"

[task.prepare]
command = "mkdir -p ${TARGET}"
outputs = ["${TARGET}/"]
aliases = ["p"]

[task.build]
dependencies = ["prepare"]
command = "cargo build ${FLAGS}"
inputs = ["${SRC}", "Cargo.toml"]
outputs = ["${TARGET}/app"]
aliases = ["b"]

[task.test]
dependencies = ["build"]
command = "cargo test"
inputs = ["tests/**/*.rs"]
always_run = true
aliases = ["t"]

[task.clean]
command = "rm -rf ${TARGET}"

Reference

Task Fields

Field	Type	Description
`command`	String	Required. Shell command to execute.
`dependencies`	[String]	List of task IDs that must complete first.
`inputs`	[String]	List of files/globs to track for changes.
`outputs`	[String]	List of files/globs this task produces.
`aliases`	[String]	Short names for CLI invocation (e.g. `["b"]`).
`always_run`	Boolean	If true, ignore cache and always execute.
`auto_remove`	Boolean	If true, delete outputs after success (temp files).
`timeout`	String	Duration string (e.g. "30s") for this specific task.

Caching & Execution Logic

Compi uses a local cache (compi_cache.json) to skip tasks that are up-to-date.

A task is SKIPPED if:

All outputs exist.
The inputs content hash matches the previous run.
The inputs modification times are older than the outputs.

A task RUNS if:

It has no inputs defined.
always_run is set to true.
Any output file is missing.
Input files have changed (content hash mismatch).
Input files are newer than output files.

Output Cleanup

--rm flag: Deletes files listed in outputs after the task succeeds.
auto_remove = true: Acts like --rm is always passed for that specific task.

License

MIT

Commit count: 14