package-bootstrap 0.1.0

An embeddable solution for installing build artifacts
Documentation 
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

Contents
========
- [About](#about)
- [Usage](#usage)
- [Features](#features)

## About
Package bootstrap is an embeddable installer for Rust binaries that allows the
reuse of the code in your project to generate shell completions, manpages and
other artifacts and install them into directories appropriate for a Unix system.

## Usage
```toml
# Cargo.toml
[[bin]]
name = "bootstrap"
path = "src/bootstrap.rs

[dependencies.package_bootstrap]
version = "0.1"
features = ["complete", "mangen"]
```
```Rust
// bootstrap.rs
use clap::Command;
use package_bootstrap::Bootstrap;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let cmd = Command::new("foo")
        .about("manage all of your bars");

    let bootstrap = Bootstrap::new("foo", cmd);
    bootstrap.install(Path::new("pkg/usr", 1)?;
}
```
With a little extra setup, bootstrap can use the same function as your binary to
generate the `clap::Command` struct.
```toml
# Cargo.toml
[workspace]
members = "cli"

[workspace.dependencies]
clap = 4.1
cli = { path = "cli" }
```
```Rust
// cli/src/lib.rs
pub fn cli() -> clap::Command {
    Command::new("foo")
        .about("Handle all of your bars")
}
```
## Features
- default: complete - generates and installs shell completions from your clap::Command
  struct
- mangen: - generates and installs a Unix manual page from your clap::Command struct
### Supported shells:
- bash
- elvish
- fish
- nushell
- powershell
- zsh