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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
//! The command-line surface.
//!
//! This file only parses: it turns `argv` into a struct. All semantics (detection,
//! resolution, spawn) live elsewhere.
use std::ffi::OsString;
use std::path::PathBuf;
use clap::{Parser, Subcommand};
/// Global arguments. They apply to every subcommand, hence `global`.
#[derive(Debug, Parser)]
#[command(
name = "pmpx",
version,
about = "One command surface: detect the project type and forward to the real tool",
long_about = None,
arg_required_else_help = false,
)]
pub struct Cli {
/// Print what happens as JSON -- one object per line, on stdout -- instead of the human text.
///
/// Only the execution commands have a JSON form: stdout is then a stream a program can read, and
/// everything meant for a person (including the backend's own output) goes to stderr. A command
/// whose result is a table refuses the flag rather than mixing prose into the stream.
#[arg(long = "json", global = true)]
pub json: bool,
/// Report what the decision was based on -- markers, pins, scores, the winner -- and run nothing.
#[arg(long = "explain", global = true)]
pub explain: bool,
/// Use this plugin for now, overriding `.pmpx.toml`
///
/// A one-off override that is not written to disk. To pin it, use `pmpx plugin set`.
#[arg(short = 'p', long = "plugin", global = true, value_name = "NAME")]
pub plugin: Option<String>,
/// Operate in this directory (same as cd'ing there first)
#[arg(short = 'C', long = "dir", global = true, value_name = "PATH")]
pub dir: Option<PathBuf>,
/// Only check the current directory, do not walk up to the project root
#[arg(long = "no-walk-up", global = true)]
pub no_walk_up: bool,
/// Suppress hints and the resolved command on stderr (ambiguous detection, uninstalled
/// candidates, ...)
#[arg(short = 'q', long = "quiet", global = true)]
pub quiet: bool,
/// Print debug information for this run
///
/// It goes to stderr, and `--quiet` does not turn it off.
#[arg(long = "debug", global = true)]
pub debug: bool,
#[command(subcommand)]
pub command: Option<Command>,
}
/// The subcommand table.
#[derive(Debug, Subcommand)]
pub enum Command {
/// Install dependencies. No arguments = install the whole tree; with arguments = add
/// them
#[command(visible_aliases = ["i", "add"])]
Install {
/// Dependencies to add; empty means install the whole tree
#[arg(value_name = "PKG")]
packages: Vec<OsString>,
},
/// Remove dependencies
#[command(visible_aliases = ["rm", "uninstall"])]
Remove {
/// Dependencies to remove
#[arg(value_name = "PKG", required = true)]
packages: Vec<OsString>,
},
/// Run a script / target
#[command(visible_alias = "r")]
Run {
/// Script name / target name. Usually empty under cargo
#[arg(value_name = "TARGET")]
target: Option<OsString>,
/// What follows `--` is passed to the backend verbatim, with no interpretation
#[arg(last = true, value_name = "ARG")]
args: Vec<OsString>,
},
/// Build
#[command(visible_alias = "b")]
Build {
/// What follows `--` is passed to the backend verbatim
#[arg(last = true, value_name = "ARG")]
args: Vec<OsString>,
},
/// Test
#[command(visible_alias = "t")]
Test {
/// What follows `--` is passed to the backend verbatim
#[arg(last = true, value_name = "ARG")]
args: Vec<OsString>,
},
/// Update dependencies
#[command(visible_alias = "up")]
Update {
/// Only update these dependencies; empty means all of them
#[arg(value_name = "PKG")]
packages: Vec<OsString>,
},
/// Escape hatch: run any command. When the plugin does not support it, pmpx passes it through verbatim itself
#[command(visible_alias = "x")]
Exec {
/// The command and its arguments
#[arg(
value_name = "CMD",
required = true,
trailing_var_arg = true,
allow_hyphen_values = true
)]
command: Vec<OsString>,
},
/// Verbose: project root, candidates and scores, plugin versions, ABI diagnostics
Info,
/// Manage plugins
#[command(subcommand)]
Plugin(PluginCommand),
/// Read and write the global config
#[command(subcommand)]
Config(ConfigCommand),
/// Print a shell completion script to stdout; redirect it yourself
Completion {
/// Target shell
#[arg(value_name = "SHELL")]
shell: clap_complete::Shell,
},
/// Manage pmpx itself
#[command(name = "self")]
SelfTool {
#[command(subcommand)]
command: SelfCommand,
},
}
/// `pmpx self <...>`
#[derive(Debug, Subcommand)]
pub enum SelfCommand {
/// Replace this binary with one of the project's releases
///
/// Only for installations that are not managed by cargo; a `cargo install` is told to
/// run `cargo install pmpx --force` instead.
Update {
/// Report what is available and change nothing
///
/// It answers a question, so it combines with neither `--version` (which asks for a
/// specific release) nor `--force` (which asks to reinstall).
#[arg(long, conflicts_with_all = ["version", "force"])]
check: bool,
/// Install this version instead of the newest one; also how a rollback is done
#[arg(long, value_name = "VERSION")]
version: Option<String>,
/// Reinstall even when this version is already the one running
#[arg(long)]
force: bool,
},
}
/// `pmpx plugin <...>`
#[derive(Debug, Subcommand)]
pub enum PluginCommand {
/// List installed plugins grouped by family (reads manifests only, no dlopen)
#[command(visible_alias = "list")]
Ls {
/// Flat output, no grouping
#[arg(long)]
flat: bool,
},
/// The current plugin per family, plus candidates and scores
Current,
/// Pin a plugin in `.pmpx.toml` (only affects the family it belongs to)
Set {
/// Plugin name, for example `pnpm`
#[arg(value_name = "NAME")]
name: String,
},
/// Delete a pin from `.pmpx.toml`
Unset {
/// Only delete this family; empty means all of them (which then requires `--yes`)
#[arg(value_name = "FAMILY")]
family: Option<String>,
/// Confirm deleting all of them
#[arg(long)]
yes: bool,
},
/// Install plugins
Add {
/// Plugin name, for example `pnpm` (expands to `pmpx-plugin-pnpm`)
#[arg(value_name = "NAME", required = true)]
names: Vec<String>,
/// A specific version; empty means latest
#[arg(long, value_name = "VERSION")]
version: Option<String>,
},
/// Remove plugins
Rm {
/// Plugin name
#[arg(value_name = "NAME", required = true)]
names: Vec<String>,
},
/// Update plugins
Update {
/// Only update this plugin; empty means all of them
#[arg(value_name = "NAME")]
names: Vec<String>,
/// A specific version; only valid together with a single plugin name
#[arg(long, value_name = "VERSION")]
version: Option<String>,
},
/// Search crates.io for plugins
Search {
/// Keyword
#[arg(value_name = "KEYWORD", required = true)]
keyword: String,
/// Show at most this many
#[arg(long, default_value_t = 20, value_name = "N")]
limit: usize,
},
/// Show a plugin's crates.io information
Info {
/// Plugin name
#[arg(value_name = "NAME")]
name: String,
},
}
/// `pmpx config <...>`
#[derive(Debug, Subcommand)]
pub enum ConfigCommand {
/// Read one key. Dotted paths work, for example `plugin.family_priority`
Get {
/// Key name
#[arg(value_name = "KEY")]
key: String,
},
/// Write one key. Only writes the global config, never a project `.pmpx.toml`
Set {
/// Key name
#[arg(value_name = "KEY")]
key: String,
/// Value. Parsed according to its existing type (array / boolean / number / string)
#[arg(value_name = "VALUE")]
value: String,
},
}