Skip to content

Commit 0cf2bd1

Browse files
author
Your Name
committed
Add help docs and man page
1 parent 16149e5 commit 0cf2bd1

3 files changed

Lines changed: 90 additions & 0 deletions

File tree

README.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -791,3 +791,7 @@ For the latest updates, see link:ROADMAP.adoc[ROADMAP.adoc] and link:STATE.scm[S
791791
== Problems → Solutions
792792

793793
See link:problems-solutions/README.adoc[problems-solutions] for real-world failure cases and how OPSM should resolve them.
794+
795+
== Help
796+
797+
See link:docs/HELP.adoc[HELP].

docs/HELP.adoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
// SPDX-License-Identifier: PMPL-1.0-or-later
2+
= OPSM Help
3+
:toc: preamble
4+
:toclevels: 2
5+
6+
== Quick Start
7+
8+
[source,bash]
9+
----
10+
opsm install @npm lodash
11+
opsm search "http client"
12+
opsm install [rpm-ostree: gcc clang] [toolbox: zig ocaml]
13+
----
14+
15+
== Smart Install (Dry‑Run)
16+
17+
Use backend grouping to plan installs across rpm‑ostree, toolbox, containers, and source.
18+
19+
[source,bash]
20+
----
21+
opsm install [rpm-ostree: gnat ada] [toolbox: zig ghc]
22+
----
23+
24+
== Policies
25+
26+
* `¬python` — block Python ecosystems
27+
* Approved‑only installs for users
28+
* Dry‑run plans always available
29+
30+
== Troubleshooting
31+
32+
If a package is missing or unmaintained, OPSM should:
33+
34+
* warn clearly
35+
* suggest alternatives
36+
* provide a reversible plan
37+
38+
See link:../problems-solutions/README.adoc[problems‑solutions].

man/opsm.1

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
.TH OPSM 1 "January 2026" "OPSM" "User Commands"
2+
.SH NAME
3+
opsm \- Odds-and-sods package manager
4+
.SH SYNOPSIS
5+
.B opsm
6+
.RI [command] " [options]"
7+
.SH DESCRIPTION
8+
OPSM is a federated package manager that resolves across multiple ecosystems and system package managers.
9+
It supports dry-run planning, trust pipeline checks, and reversible operations.
10+
.SH COMMANDS
11+
.TP
12+
.B install [@forth] <pkg>
13+
Install a package from a specific registry.
14+
.TP
15+
.B install [backend:] ...
16+
Smart install grouping (dry-run plan by backend).
17+
.TP
18+
.B remove <pkg>
19+
Remove an installed package.
20+
.TP
21+
.B search <query>
22+
Search across registries.
23+
.TP
24+
.B info <pkg>
25+
Show package info.
26+
.TP
27+
.B audit <pkg>
28+
Run sustainability + license analysis.
29+
.TP
30+
.B ports
31+
List available system package managers.
32+
.SH OPTIONS
33+
.TP
34+
.B -n, --dry-run
35+
Show what would be done.
36+
.TP
37+
.B --apply
38+
Apply smart install plan (when wired).
39+
.SH CONFIG
40+
Default config lookup order:
41+
.BR $OPSM_CONFIG
42+
, ./opsm.toml, ~/.config/opsm/opsm.toml.
43+
.SH EXAMPLES
44+
.nf
45+
opsm install @npm lodash
46+
opsm install [rpm-ostree: gcc clang] [toolbox: zig ocaml]
47+
opsm search "http client"
48+
.fi

0 commit comments

Comments
 (0)