cpkg 0.12.1

A dead simple C package manager.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

<h1 align="center"> cpkg </h1>

<p align="center">
	A dead simple, modern package manager for C.
</p>

<div align="center">
	<a href="https://github.com/DvvCz/cpkg/actions">
		<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/DvvCz/cpkg/nightly.yml?label=nightly">
	</a>
	<a href="https://crates.io/crates/cpkg">
		<img alt="Crates.io Version" src="https://img.shields.io/crates/v/cpkg">
	</a>
	<a href="https://github.com/DvvCz/cpkg/releases/latest">
		<img alt="GitHub Release" src="https://img.shields.io/github/v/release/DvvCz/cpkg">
	</a>
</div>

## What is cpkg?

`cpkg` is an all-in-one wrapper for tools like `gcc`, `clang`, `doxygen` and `clang-format`.  
It automatically detects which are present on your system, allowing you to use them with one simple cli.

Inspired by the convenience of modern tools like `cargo` and `bun`.

## Usage

```bash
cpkg init
cpkg run
```

## Features

### 🧑‍💻 Project Runner

You can create a project with `new` or `init`, and then run `/src/main.c` with `cpkg run` or `cpkg build`.

You can run tests located in `/src/*.test.c` and `/tests/*.c` with `cpkg test`.

### 📦 Package Management

You can add local paths with `cpkg add <name> --path /path/to/dependency` and git dependencies with `cpkg add <name> --git https://github.com/nothings/stb/tree/master`.

### 🗄️ Project File Generation

Project files can be generated using `cpkg generate`.

This creates a project file that acts as if you ran `cpkg build`, without `cpkg`.

*Currently only supports basic [`Makefile`](https://www.gnu.org/software/make) generation*

### 🛠️ Other Components

`cpkg` supports other functionalities:

* Formatting using [`clang-format`](https://clang.llvm.org/docs/ClangFormat.html)
* Documenting using [`doxygen`](https://www.doxygen.nl)

## ⏬ Installation

### 📩 Releases

You can download the `cpkg` binary from [the releases](https://github.com/DvvCz/cpkg/releases) (or a nightly build from [actions](https://github.com/DvvCz/cpkg/actions))

### 📦 Cargo

If you have `cargo` you can install from crates.io.

```
cargo install cpkg
```

Or clone the repository and install it locally.

```
git clone https://github.com/DvvCz/cpkg
cargo install --path cpkg
```

### 🛜 cURL script

The other options are preferred, but there is an install script.

```bash
curl -fsSL https://raw.githubusercontent.com/DvvCz/cpkg/master/install.sh | bash
```

### 🔄 Upgrading

You can easily upgrade your `cpkg` binary using the `cpkg upgrade` command.