new: Add proto shell command. (#879)

Author: milesj

CHANGELOG.md

@@ -23,6 +23,12 @@
   - Pre-builts will now use a much smaller archive when downloading.
   - Fixed a UTF-8 unpacking error.
 
+#### 🚀 Updates
+
+- Added a new command, `proto shell`, that will initialize a list of tools into the environment and start an interactive shell session.
+  - By default, it will use the current shell, but you can override this with the `--shell` option.
+  - Example: `proto shell node@20 npm@10`
+
 #### ⚙️ Internal
 
 - Updated dependencies.

crates/cli/src/app.rs

@@ -1,7 +1,7 @@
 use crate::commands::{
     ActivateArgs, AliasArgs, BinArgs, CleanArgs, CompletionsArgs, DiagnoseArgs, ExecArgs,
-    InstallArgs, MigrateArgs, OutdatedArgs, PinArgs, RegenArgs, RunArgs, SetupArgs, StatusArgs,
-    UnaliasArgs, UninstallArgs, UnpinArgs, UpgradeArgs, VersionsArgs,
+    InstallArgs, MigrateArgs, OutdatedArgs, PinArgs, RegenArgs, RunArgs, SetupArgs, ShellArgs,
+    StatusArgs, UnaliasArgs, UninstallArgs, UnpinArgs, UpgradeArgs, VersionsArgs,
     debug::{DebugConfigArgs, DebugEnvArgs},
     plugin::{AddPluginArgs, InfoPluginArgs, ListPluginsArgs, RemovePluginArgs, SearchPluginArgs},
 };
@@ -293,6 +293,13 @@ pub enum Commands {
     )]
     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."

crates/cli/src/commands/exec.rs

@@ -12,20 +12,20 @@ use starbase_shell::ShellType;
 #[derive(Args, Clone, Debug)]
 pub struct ExecArgs {
     #[arg(help = "Tools to initialize")]
-    tools: Vec<String>,
+    pub tools: Vec<String>,
 
     #[arg(long, help = "Inherit tools to initialize from .prototools configs")]
-    tools_from_config: bool,
+    pub tools_from_config: bool,
 
     #[arg(long, help = "Execute the command as-is without quoting or escaping")]
-    raw: bool,
+    pub raw: bool,
 
     #[arg(long, help = "Shell to execute the command with")]
-    shell: Option<ShellType>,
+    pub shell: Option<ShellType>,
 
     // Passthrough args (after --)
     #[arg(last = true, help = "The command to execute after initializing tools")]
-    command: Vec<String>,
+    pub command: Vec<String>,
 }
 
 #[tracing::instrument(skip_all)]

crates/cli/src/commands/mod.rs

@@ -14,6 +14,7 @@ pub(crate) mod plugin;
 mod regen;
 mod run;
 mod setup;
+mod shell;
 mod status;
 mod unalias;
 mod uninstall;
@@ -35,6 +36,7 @@ pub use pin::*;
 pub use regen::*;
 pub use run::*;
 pub use setup::*;
+pub use shell::*;
 pub use status::*;
 pub use unalias::*;
 pub use uninstall::*;

crates/cli/src/commands/shell.rs

@@ -0,0 +1,58 @@
+use super::exec::*;
+use crate::error::ProtoCliError;
+use crate::session::ProtoSession;
+use clap::Args;
+use starbase::AppResult;
+use starbase_shell::ShellType;
+
+#[derive(Args, Clone, Debug)]
+pub struct ShellArgs {
+    #[arg(help = "Tools to initialize")]
+    tools: Vec<String>,
+
+    #[arg(long, help = "Shell to start a session for")]
+    shell: Option<ShellType>,
+}
+
+#[tracing::instrument(skip_all)]
+pub async fn shell(session: ProtoSession, args: ShellArgs) -> AppResult {
+    // Detect the shell that we need to activate for
+    let shell_type = match args.shell {
+        Some(value) => value,
+        None => ShellType::try_detect()?,
+    };
+
+    // Define the interactive command to use
+    let command = match shell_type {
+        ShellType::Ash => "ash -i",
+        ShellType::Bash => "bash -i",
+        ShellType::Elvish => "elvish",
+        ShellType::Fish => "fish --interactive",
+        ShellType::Ion => "ion",
+        ShellType::Murex => "murex",
+        ShellType::Nu => "nu --interactive",
+        ShellType::Pwsh => "pwsh -Interactive -NoLogo",
+        ShellType::Sh => "sh",
+        ShellType::Xonsh => "xonsh --interactive",
+        ShellType::Zsh => "zsh --interactive",
+        ShellType::PowerShell => {
+            return Err(ProtoCliError::ShellPowerShellNotSupported.into());
+        }
+    };
+
+    // Passthrough to exec
+    exec(
+        session,
+        ExecArgs {
+            tools_from_config: args.tools.is_empty(),
+            tools: args.tools,
+            raw: false,
+            shell: None,
+            command: command
+                .split_whitespace()
+                .map(|arg| arg.to_owned())
+                .collect(),
+        },
+    )
+    .await
+}

crates/cli/src/error.rs

@@ -145,6 +145,14 @@ pub enum ProtoCliError {
     )]
     RunNoSelfUpgrade { command: String, tool: String },
 
+    // SHELL
+    #[diagnostic(code(proto::commands::shell::unsupported_powershell))]
+    #[error(
+        "PowerShell (powershell.exe) does not support interactive shells. Try using pwsh (pwsh.exe) instead by passing {}.",
+        "--shell pwsh".style(Style::Shell)
+    )]
+    ShellPowerShellNotSupported,
+
     // UPGRADE
     #[diagnostic(code(proto::commands::upgrade::failed))]
     #[error("Failed to upgrade proto, {} binary could not be located after download!", .bin.style(Style::Shell))]

crates/cli/src/main.rs

@@ -101,6 +101,7 @@ async fn main() -> MainResult {
                 Commands::Regen(args) => commands::regen(session, args).await,
                 Commands::Run(args) => commands::run(session, args).await,
                 Commands::Setup(args) => commands::setup(session, args).await,
+                Commands::Shell(args) => commands::shell(session, args).await,
                 Commands::Status(args) => commands::status(session, args).await,
                 Commands::Unalias(args) => commands::unalias(session, args).await,
                 Commands::Uninstall(args) => commands::uninstall(session, args).await,