forked from
anil.recoil.org/monopam
Monorepo management for opam overlays
docs(monopam): update README with new CLI commands
Add documentation for new commands:
- add: Add a package from a git URL or lock file
- remove: Remove a package from the project
- publish: Publish packages to opam-repo
- test: Run tests across the monorepo
- clean: Remove empty commits from history
+40
-2
+40
-2
README.md
+40
-2
README.md
···
18
18
# Initialize a workspace
19
19
monopam init --handle yourname.bsky.social
20
20
21
+
# Add a package
22
+
monopam add https://github.com/ocaml/eio.git
23
+
21
24
# Pull upstream changes
22
25
monopam pull
23
26
···
35
38
36
39
| Command | Description |
37
40
|---------|-------------|
41
+
| `monopam add <url>` | Add a package from a git URL or lock file |
42
+
| `monopam remove <dir>` | Remove a package from the project |
38
43
| `monopam pull` | Fetch and merge upstream changes |
39
44
| `monopam push` | Push local changes to upstream |
40
45
| `monopam fetch` | Fetch upstream changes without merging |
41
46
| `monopam status` | Show sync status |
42
47
| `monopam diff` | Show diff vs upstream |
43
48
49
+
### Publishing
50
+
51
+
| Command | Description |
52
+
|---------|-------------|
53
+
| `monopam publish` | Publish packages to opam-repo |
54
+
| `monopam test` | Run tests across the monorepo |
55
+
44
56
### Verse Collaboration
45
57
46
58
| Command | Description |
···
52
64
| `monopam verse fork <pkg>` | Fork a package |
53
65
| `monopam verse cherrypick <sha>` | Cherry-pick a commit |
54
66
55
-
### Other
67
+
### Maintenance
56
68
57
69
| Command | Description |
58
70
|---------|-------------|
59
71
| `monopam init` | Initialize workspace |
60
-
| `monopam opam transform` | Transform opam metadata |
72
+
| `monopam clean` | Remove empty commits from history |
61
73
62
74
## Directory Structure
63
75
···
91
103
92
104
## Workflow
93
105
106
+
### Adding Packages
107
+
108
+
```bash
109
+
# Add from git URL
110
+
monopam add https://github.com/ocaml/eio.git
111
+
112
+
# Add to a specific directory
113
+
monopam add https://github.com/ocaml/eio.git ocaml-eio
114
+
115
+
# Remove a package
116
+
monopam remove ocaml-eio
117
+
```
118
+
94
119
### Daily Development
95
120
96
121
1. Pull latest:
···
112
137
```bash
113
138
monopam push
114
139
```
140
+
141
+
### Publishing to opam
142
+
143
+
```bash
144
+
# Run tests first
145
+
monopam test
146
+
147
+
# Publish all packages
148
+
monopam publish
149
+
150
+
# Publish specific packages
151
+
monopam publish eio tls
152
+
```
115
153
116
154
### Collaborating via Verse
117
155