upskill 0.3.1

Author and distribute AI-assistance content across coding agents
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
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

# Getting started

## Install

```bash
cargo install upskill
```

Or download a pre-built binary from the [releases page][releases].

`upskill` is a single static binary with no runtime dependencies.

## Install your first source (consumer)

Inside a project where you want AI clients to pick up rules / skills /
agents:

```bash
# Install everything from a source repo
upskill add driftsys/skills

# Or install a curated bundle
upskill add driftsys/bundles:platform-baseline.bundle.md

# Pin to a tag, branch, or commit
upskill add driftsys/skills@v1.2.0
```

Generated files land in `.claude/`, `.github/`, and `.agents/`. The
`.upskill-lock.json` file in your repo records what was installed and
at which ref — **commit it** so other developers and CI regenerate the
same content.

Verify state any time:

```bash
upskill list      # what's installed
upskill doctor    # any drift between lockfile and on-disk output?
upskill update    # re-fetch sources and regenerate
```

## Scaffold your first item (author)

Inside a source-registry repo (where SSOT items live):

```bash
upskill new skill code-review
```

This writes `skills/code-review/SKILL.md` with the minimum frontmatter
the format spec requires. Open it, replace the `TODO` description and
body, then run:

```bash
upskill lint --strict   # validate against the format spec
upskill fmt             # canonicalise YAML frontmatter
```

You can also scaffold rules (`upskill new rule <name>`) and agents
(`upskill new agent <name>`).

## Man pages

`upskill` ships a man-page generator. Run it from the source tree:

```bash
just man             # or: cargo run --example mangen --release
```

That writes one `.1` per command into `target/man/`:

```text
target/man/upskill.1
target/man/upskill-add.1
target/man/upskill-doctor.1
…
```

Install system-wide:

```bash
sudo cp target/man/*.1 /usr/local/share/man/man1/
man upskill          # or: man upskill-add
```

## Where to next

- **[Commands](./commands.md)** — every verb explained, with flags.
- **[Recipes](./recipes.md)** — CI, private repos, pinning, cleanup.
- **[Portable format](./format-spec.md)** — the on-disk SSOT contract
  the lint validates against.

[releases]: https://github.com/driftsys/upskill/releases