cpr-cli 0.1.4

A simple git-based project manager aimed at C/C++
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
92

# CPR

**C** **PR**oject manager

[![Crates.io Version](https://img.shields.io/crates/v/cpr-cli)](https://crates.io/crates/cpr-cli)
[![Crates.io Size](https://img.shields.io/crates/size/cpr-cli)](https://crates.io/crates/cpr-cli)
[![Crates.io License](https://img.shields.io/crates/l/cpr-cli)](https://crates.io/crates/cpr-cli)
[![Crates.io Total Downloads](https://img.shields.io/crates/d/cpr-cli)](https://crates.io/crates/cpr-cli)

## Description

CPR is a simple command line utility for managing C/C++ projects through templates. It allows you to initialize a new project and start working quickly while also giving template maintainers flexibility in how they want to structure their templates.

## Features

- Fetch templates from GitHub
- Custom template questions
- `if` and `for` statements in templates
- Nested templates (TODO)

## Non-Goals

While the structure of this project is not fully defined yet, the following are **NOT** goals of this project:

- A full-fledged build system
- A package manager

## Installation

### Prerequisites

- Cargo
- Rust 1.74.1 or later

### Using `cargo install`

```bash
cargo install cpr-cli
```

### Using `cargo build`

```bash
git clone https://github.com/cpr-rs/cpr.git
cd cpr
cargo build --release
```

## Usage

```helptext
A simple git-based project manager aimed at C/C++

Usage: cpr [OPTIONS] <COMMAND>

Commands:
  init  Initialize a directory with a template
  new   Create a new project with a template
  help  Print this message or the help of the given subcommand(s)

Options:
  -c, --config <CONFIG>  Global configuration file path
  -h, --help             Print help
  -V, --version          Print version
```

## Configuration

The default configuration file should be located at `$HOME/.cpr/config.toml`. You can specify a custom configuration file using the `-c` or `--config` flag. Below is the default configuration file:

```toml
default_service = "gh"

[services.gh]
url = "https://github.com/{{ repo }}.git"

[services.gl]
url = "https://gitlab.com/{{ repo }}.git"

[services.bb]
url = "https://bitbucket.org/{{ repo }}.git"
```

Each prefix can then be used to fetch templates from the respective service. `{{ repo }}` will be replaced with the given requested repository. For example, to fetch the `cpr-rs/cpp` template from GitHub, you can use the following command:

```bash
cpr new gh:cpr-rs/cpp
```

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.