proto_cli 0.59.0

A multi-language version manager, a unified toolchain.
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
use crate::commands::{
    ActivateArgs, AliasArgs, BinArgs, CleanArgs, CompletionsArgs, DiagnoseArgs, ExecArgs,
    InstallArgs, McpArgs, MigrateArgs, OutdatedArgs, PinArgs, RegenArgs, RunArgs, SetupArgs,
    ShellArgs, StatusArgs, UnaliasArgs, UninstallArgs, UnpinArgs, UpgradeArgs, VersionsArgs,
    debug::{DebugConfigArgs, DebugEnvArgs},
    plugin::{PluginAddArgs, PluginInfoArgs, PluginListArgs, PluginRemoveArgs, PluginSearchArgs},
};
use clap::builder::styling::{Color, Style, Styles};
use clap::{Parser, Subcommand, ValueEnum};
use proto_core::{ConfigMode, reporter::ReporterFormat};
use starbase_styles::color::Color as ColorType;
use std::{
    env,
    fmt::{Display, Error, Formatter},
    path::PathBuf,
};

fn default_reporter() -> ReporterFormat {
    if ai_env::is_ai_agent() {
        ReporterFormat::Ndjson
    } else {
        ReporterFormat::Text
    }
}

#[derive(ValueEnum, Clone, Debug, Default)]
pub enum AppTheme {
    #[default]
    Dark,
    Light,
}

#[derive(ValueEnum, Clone, Debug, Default)]
pub enum LogLevel {
    Off,
    Error,
    Warn,
    #[default]
    Info,
    Debug,
    Trace,
    Verbose,
}

impl LogLevel {
    pub fn is_verbose(&self) -> bool {
        matches!(self, Self::Verbose)
    }
}

impl Display for LogLevel {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error> {
        write!(
            f,
            "{}",
            match self {
                LogLevel::Off => "off",
                LogLevel::Error => "error",
                LogLevel::Warn => "warn",
                LogLevel::Info => "info",
                LogLevel::Debug => "debug",
                // Must map to tracing levels
                LogLevel::Trace | LogLevel::Verbose => "trace",
            }
        )?;

        Ok(())
    }
}

fn fg(ty: ColorType) -> Style {
    Style::new().fg_color(Some(Color::from(ty as u8)))
}

fn create_styles() -> Styles {
    Styles::default()
        .error(fg(ColorType::Red))
        .header(Style::new().bold())
        .invalid(fg(ColorType::Yellow))
        .literal(fg(ColorType::Pink)) // args, options, etc
        .placeholder(fg(ColorType::GrayLight))
        .usage(fg(ColorType::Purple).bold())
        .valid(fg(ColorType::Green))
}

#[derive(Clone, Debug, Parser)]
#[command(
    name = "proto",
    version,
    about,
    long_about = None,
    disable_help_subcommand = true,
    propagate_version = true,
    next_line_help = false,
    styles = create_styles()
)]
pub struct App {
    #[arg(
        value_enum,
        long,
        short = 'c',
        global = true,
        env = "PROTO_CONFIG_MODE",
        help = "Mode in which to load configuration"
    )]
    pub config_mode: Option<ConfigMode>,

    #[arg(
        long,
        global = true,
        env = "PROTO_DUMP",
        help = "Dump a trace profile to the working directory"
    )]
    pub dump: bool,

    #[arg(
        value_enum,
        default_value_t,
        long,
        short = 'l',
        global = true,
        env = "PROTO_LOG",
        help = "Lowest log level to output"
    )]
    pub log: LogLevel,

    #[arg(
        long,
        global = true,
        env = "PROTO_LOG_FILE",
        help = "Path to a file to write logs to"
    )]
    pub log_file: Option<PathBuf>,

    #[arg(
        long,
        global = true,
        env = "PROTO_JSON",
        help = "Print output as JSON (when applicable)"
    )]
    pub json: bool,

    #[arg(
        long,
        global = true,
        env = "PROTO_OTEL",
        help = "Export traces and metrics over OTLP using OTEL_EXPORTER_OTLP_* settings"
    )]
    pub otel: bool,

    #[arg(
        long,
        global = true,
        env = "PROTO_OTEL_LOGS",
        help = "Export tracing events as OTLP logs using OTEL_EXPORTER_OTLP_* settings"
    )]
    pub otel_logs: bool,

    #[arg(
        long,
        global = true,
        env = "PROTO_OTEL_SERVICE_NAME",
        help = "Service name to report when OTLP tracing is enabled"
    )]
    pub otel_service_name: Option<String>,

    #[arg(
        value_enum,
        long,
        short = 'r',
        global = true,
        env = "PROTO_REPORTER",
        help = "Print output in a specific format"
    )]
    pub reporter: Option<ReporterFormat>,

    #[arg(
        value_enum,
        default_value_t,
        long,
        short = 't',
        global = true,
        env = "PROTO_THEME",
        help = "Terminal theme to print with"
    )]
    pub theme: AppTheme,

    #[arg(
        long,
        short = 'y',
        global = true,
        env = "PROTO_YES",
        help = "Avoid all interactive prompts and use defaults"
    )]
    pub yes: bool,

    #[command(subcommand)]
    pub command: Commands,
}

/// Who owns the stdout stream for the current command invocation.
///
/// Reporter-owned commands write formatted output to stdout. Every other
/// owner reserves stdout for its protocol payload and routes reporter output
/// to stderr.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum StdoutOwner {
    Reporter,
    ShellCode,
    CompletionCode,
    McpStdio,
}

impl App {
    pub fn is_reporter_explicit(&self) -> bool {
        self.json || self.reporter.is_some()
    }

    pub fn stdout_owner(&self) -> StdoutOwner {
        match &self.command {
            Commands::Activate(args) => {
                if self.is_reporter_explicit() && self.reporter_format().is_json() && !args.export {
                    StdoutOwner::Reporter
                } else {
                    StdoutOwner::ShellCode
                }
            }
            Commands::Completions(_) => StdoutOwner::CompletionCode,
            Commands::Mcp(args) => {
                if args.info {
                    StdoutOwner::Reporter
                } else {
                    StdoutOwner::McpStdio
                }
            }
            _ => StdoutOwner::Reporter,
        }
    }

    pub fn reporter_format(&self) -> ReporterFormat {
        match self.reporter {
            Some(format) if format.is_json() => format,
            _ if self.json => ReporterFormat::Json,
            Some(format) => format,
            None => default_reporter(),
        }
    }

    pub fn setup_env_vars(&self) {
        unsafe {
            env::set_var("PROTO_APP_LOG", self.log.to_string());
            env::set_var("PROTO_VERSION", env!("CARGO_PKG_VERSION"));

            if let Ok(value) = env::var("PROTO_DEBUG_COMMAND") {
                env::set_var("WARPGATE_DEBUG_COMMAND", value);
            }

            if let Ok(value) = env::var("PROTO_GITHUB_TOKEN") {
                env::set_var("WARPGATE_GITHUB_TOKEN", value);
            }

            env::set_var(
                "STARBASE_THEME",
                match self.theme {
                    AppTheme::Dark => "dark",
                    AppTheme::Light => "light",
                },
            );

            // Disable ANSI colors in JSON output
            if self.reporter_format().is_json() {
                env::set_var("NO_COLOR", "1");
                env::remove_var("FORCE_COLOR");
            }
        }
    }
}

#[derive(Clone, Debug, Subcommand)]
pub enum Commands {
    #[command(
        name = "activate",
        about = "Activate proto for the current shell session by prepending tool directories to PATH and setting environment variables.",
        long_about = "Activate proto for the current shell session by prepending tool directories to PATH and setting environment variables.\n\nThis should be ran within your shell profile.\nLearn more: https://moonrepo.dev/docs/proto/workflows"
    )]
    Activate(ActivateArgs),

    #[command(
        alias = "a",
        name = "alias",
        about = "Add an alias to a tool.",
        long_about = "Add an alias to a tool, that maps to a specific version, or another alias."
    )]
    Alias(AliasArgs),

    #[command(
        name = "bin",
        about = "Display the absolute path to a tool's executable(s).",
        long_about = "Display the absolute path to a tool's executable(s). If no version is provided,\nit will be detected from the current environment."
    )]
    Bin(BinArgs),

    #[command(
        name = "clean",
        about = "Clean the ~/.proto directory by removing stale tools, plugins, and files."
    )]
    Clean(CleanArgs),

    #[command(
        name = "completions",
        about = "Generate command completions for your current shell."
    )]
    Completions(CompletionsArgs),

    #[command(name = "debug", about = "Debug the current proto environment.")]
    Debug {
        #[command(subcommand)]
        command: DebugCommands,
    },

    #[command(
        alias = "doctor",
        name = "diagnose",
        about = "Diagnose potential issues with your proto installation."
    )]
    Diagnose(DiagnoseArgs),

    #[command(
        alias = "x",
        name = "exec",
        about = "Initialize a list of tools into the environment and execute an arbitrary command."
    )]
    Exec(ExecArgs),

    #[command(
        aliases = ["i", "u", "use"],
        name = "install",
        about = "Download and install one or many tools.",
        long_about = "Download and install one or many tools by version into ~/.proto/tools.\n\nIf no arguments are provided, will install all tools configured in .prototools.\n\nIf a name argument is provided, will install a single tool by version."
    )]
    Install(InstallArgs),

    #[command(
        name = "mcp",
        about = "Start an MCP server to handle tool, resource, and prompt requests for AI agents."
    )]
    Mcp(McpArgs),

    #[command(
        name = "migrate",
        about = "Migrate breaking changes for the proto installation."
    )]
    Migrate(MigrateArgs),

    #[command(
        alias = "o",
        name = "outdated",
        about = "Check if configured tool versions are out of date."
    )]
    Outdated(OutdatedArgs),

    #[command(
        alias = "p",
        name = "pin",
        about = "Pin a global or local version of a tool.",
        long_about = "Pin a version of a tool globally to ~/.proto/.prototools, or locally to ./.prototools."
    )]
    Pin(PinArgs),

    #[command(
        alias = "tool", // Deprecated
        name = "plugin",
        about = "Operations for managing tool plugins."
    )]
    Plugin {
        #[command(subcommand)]
        command: PluginCommands,
    },

    #[command(name = "regen", about = "Regenerate shims and optionally relink bins.")]
    Regen(RegenArgs),

    #[command(
        alias = "r",
        name = "run",
        about = "Run a tool after detecting a version from the environment.",
        long_about = "Run a tool after detecting a version from the environment. In order of priority,\na version will be resolved from a provided CLI argument, a PROTO_VERSION environment variable,\na local version file (.prototools), and lastly a global version file (~/.proto/tools).\n\nIf no version can be found, the program will exit with an error."
    )]
    Run(RunArgs),

    #[command(
        name = "setup",
        about = "Setup proto for your current shell by injecting exports and updating PATH."
    )]
    Setup(SetupArgs),

    #[command(
        aliases = ["sh", "session"],
        name = "shell",
        about = "Initialize a list of tools into the environment and start an interactive shell session."
    )]
    Shell(ShellArgs),

    #[command(
        name = "status",
        about = "List all configured tools and their current installation status."
    )]
    Status(StatusArgs),

    #[command(alias = "ua", name = "unalias", about = "Remove an alias from a tool.")]
    Unalias(UnaliasArgs),

    #[command(
        alias = "ui",
        name = "uninstall",
        about = "Uninstall a tool.",
        long_about = "Uninstall a tool and remove the installation from ~/.proto/tools."
    )]
    Uninstall(UninstallArgs),

    #[command(
        alias = "uv",
        name = "unpin",
        about = "Unpin a global or local version of a tool."
    )]
    Unpin(UnpinArgs),

    #[command(
        alias = "up",
        name = "upgrade",
        about = "Upgrade proto to the latest version."
    )]
    Upgrade(UpgradeArgs),

    #[command(
        alias = "vs",
        name = "versions",
        about = "List available versions for a tool.",
        long_about = "List available versions for a tool by resolving versions from the tool's remote release manifest."
    )]
    Versions(VersionsArgs),
}

#[derive(Clone, Debug, Subcommand)]
pub enum DebugCommands {
    #[command(
        name = "config",
        about = "Debug all loaded .prototools config's for the current directory."
    )]
    Config(DebugConfigArgs),

    #[command(name = "env", about = "Debug the current proto environment and store.")]
    Env(DebugEnvArgs),
}

#[derive(Clone, Debug, Subcommand)]
pub enum PluginCommands {
    #[command(
        name = "add",
        about = "Add a plugin.",
        long_about = "Add a plugin to a .prototools config file."
    )]
    Add(PluginAddArgs),

    #[command(
        name = "info",
        about = "Display information about an installed plugin and its inventory."
    )]
    Info(PluginInfoArgs),

    #[command(
        name = "list",
        about = "List all configured and built-in plugins, and optionally include inventory."
    )]
    List(PluginListArgs),

    #[command(
        name = "remove",
        about = "Remove a plugin.",
        long_about = "Remove a plugin from a .prototools config file."
    )]
    Remove(PluginRemoveArgs),

    #[command(
        name = "search",
        about = "Search for available plugins provided by the community."
    )]
    Search(PluginSearchArgs),
}