crane 0.3.0

Easily add bricks (files or snippets) to your projects!
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

<div align="center">
<h1>crane 🏗️</h1>

Create, use and share easily reusable bootstrap packages called bricks.
<br>
<br>
<sup>
⭐ Consider starring this repo – your support motivates me a lot! ⭐
</sup>
<div>
<a href="https://crates.io/crates/crane">
  <img alt="Crates.io Version" src="https://img.shields.io/crates/v/crane">
</a>
<a href="https://crates.io/crates/crane">
  <img alt="Crates.io Total Downloads" src="https://img.shields.io/crates/d/crane">
</a>
<a href="https://github.com/timothebot/crane/">
  <img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/timothebot/crane">
</a>
</div>
<br>
<a href="https://crane.tiimo.space/setup">Setup</a>
&nbsp;~&nbsp;
<a href="https://crane.tiimo.space/faq">FAQ</a>
&nbsp;~&nbsp;
<a href="https://crane.tiimo.space/">Documentation</a>
</div>



<br>

Crane is a CLI tool that allows you to create *bricks* that you can later add to any project.

A brick is an instruction. It can be a file that gets added, a command that
executes or lines getting replaced in a target file.

## Examples

### License brick

Instead of having to look up and copy your desired license from the web, you can create a brick out of it and then run `crane add some-license`.

### Language specific bricks

You can create multiple bricks and combine them behind an alias.

This way, you can easily bootstrap new projects!

```shell
$ cargo new my_project && cd my_project
# ...
$ crane add rust
→ Executing 4 bricks
  • mit
  • serde
  • rustfmt
  • rustauthor
# ...
```

## Getting Started

Install the CLI using cargo (more options coming soon!)

```shell
cargo install crane
```

and set up shell completions (not required):

<details>
<summary>ZSH</summary>

```shell
# ~/.zshrc
eval "$(crane completion zsh)"
```

</details>

<details>
<summary>Bash</summary>

```shell
# ~/.bashrc
eval "$(crane completion bash)"
```

</details>

<details>
<summary>Fish</summary>

```shell
# ~/.config/fish/config.fish
crane completion fish | source
```

</details>

## Issues & Contributions

Feel free to open an issue or a PR. Help is always appreciated!

---

made with <3 by [timothebot](https://github.com/timothebot)