Shebang args

modules/cli/src/main/scala/scala/cli/ScalaCli.scala

@@ -31,6 +31,7 @@ object ScalaCli extends CommandsEntryPoint {
     Package,
     Run,
     SetupIde,
+    Shebang,
     Test,
     Update,
     Version

modules/cli/src/main/scala/scala/cli/commands/DefaultBase.scala

@@ -23,7 +23,10 @@ class DefaultBase(
   }
   def run(options: RunOptions, args: RemainingArgs): Unit =
     if (anyArgs)
-      Run.run(options, args, defaultInputs = () => None)
+      Run.run(
+        options,
+        args
+      )
     else
       helpAsked(finalHelp.progName, Right(options))
 }

modules/cli/src/main/scala/scala/cli/commands/Run.scala

@@ -17,10 +17,20 @@ object Run extends ScalaCommand[RunOptions] {
   override def sharedOptions(options: RunOptions) = Some(options.shared)
 
   def run(options: RunOptions, args: RemainingArgs): Unit =
-    run(options, args, () => Inputs.default())
+    run(
+      options,
+      args.remaining,
+      args.unparsed,
+      () => Inputs.default()
+    )
 
-  def run(options: RunOptions, args: RemainingArgs, defaultInputs: () => Option[Inputs]): Unit = {
-    val inputs = options.shared.inputsOrExit(args, defaultInputs = defaultInputs)
+  def run(
+    options: RunOptions,
+    inputArgs: Seq[String],
+    programArgs: Seq[String],
+    defaultInputs: () => Option[Inputs]
+  ): Unit = {
+    val inputs = options.shared.inputsOrExit(inputArgs, defaultInputs = defaultInputs)
 
     val initialBuildOptions = options.buildOptions
     val bloopRifleConfig    = options.shared.bloopRifleConfig()
@@ -31,7 +41,7 @@ object Run extends ScalaCommand[RunOptions] {
         inputs.workspace,
         inputs.projectName,
         build,
-        args.unparsed,
+        programArgs,
         logger,
         allowExecve = allowTerminate,
         exitOnError = allowTerminate,

modules/cli/src/main/scala/scala/cli/commands/SharedOptions.scala

@@ -99,7 +99,7 @@ final case class SharedOptions(
   @Hidden
     defaultForbiddenDirectories: Boolean = true,
   @Hidden
-    forbid: List[String] = Nil
+    forbid: List[String] = Nil,
 ) {
   // format: on
 
@@ -195,6 +195,11 @@ final case class SharedOptions(
   def inputsOrExit(
     args: RemainingArgs,
     defaultInputs: () => Option[Inputs] = () => Inputs.default()
+  ): Inputs = inputsOrExit(args.remaining, defaultInputs)
+
+  def inputsOrExit(
+    args: Seq[String],
+    defaultInputs: () => Option[Inputs]
   ): Inputs = {
     val download: String => Either[String, Array[Byte]] = { url =>
       val artifact = Artifact(url).withChanging(true)
@@ -209,7 +214,7 @@ final case class SharedOptions(
       .map(os.Path(_, Os.pwd))
       .map(Inputs.ResourceDirectory(_))
     val inputs = Inputs(
-      args.remaining,
+      args,
       Os.pwd,
       directories.directories,
       defaultInputs = defaultInputs,

modules/cli/src/main/scala/scala/cli/commands/Shebang.scala

@@ -0,0 +1,16 @@
+package scala.cli.commands
+
+import caseapp.RemainingArgs
+
+object Shebang extends ScalaCommand[ShebangOptions] {
+  override def stopAtFirstUnrecognized: Boolean = true
+
+  def run(options: ShebangOptions, args: RemainingArgs): Unit = {
+    Run.run(
+      options.runOptions,
+      args.remaining.headOption.toSeq,
+      args.remaining.drop(1).toSeq,
+      () => None
+    )
+  }
+}

modules/cli/src/main/scala/scala/cli/commands/ShebangOptions.scala

@@ -0,0 +1,13 @@
+package scala.cli.commands
+
+import caseapp._
+
+final case class ShebangOptions(
+  @Recurse
+  runOptions: RunOptions = RunOptions()
+)
+
+object ShebangOptions {
+  implicit lazy val parser: Parser[ShebangOptions] = Parser.derive
+  implicit lazy val help: Help[ShebangOptions]     = Help.derive
+}

modules/integration/src/test/scala/scala/cli/integration/RunTestDefinitions.scala

@@ -1050,7 +1050,7 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
     val inputs = TestInputs(
       Seq(
         os.rel / "MyScript.scala" ->
-          """#!/usr/bin/env scala-cli
+          """#!/usr/bin/env -S scala-cli shebang
             |object MyScript {
             |  def main(args: Array[String]): Unit =
             |    println("Hello" + args.map(" " + _).mkString)
@@ -1141,5 +1141,19 @@ abstract class RunTestDefinitions(val scalaVersionOpt: Option[String])
       expect(p.out.text().trim == "16")
     }
   }
-
+  if (!Properties.isWin)
+    test("CLI args passed to shebang script") {
+      val inputs = TestInputs(
+        Seq(
+          os.rel / "f.sc" -> s"""|#!/usr/bin/env -S ${TestUtil.cli.mkString(" ")} shebang -S 2.13
+                                 |using scala $actualScalaVersion
+                                 |println(args.toList)""".stripMargin
+        )
+      )
+      inputs.fromRoot { root =>
+        os.perms.set(root / "f.sc", os.PermSet.fromString("rwx------"))
+        val p = os.proc("./f.sc", "1", "2", "3", "-v").call(cwd = root)
+        expect(p.out.text().trim == "List(1, 2, 3, -v)")
+      }
+    }
 }

website/docs/cookbooks/scala-scripts.md

@@ -33,7 +33,7 @@ Hello from Scala .*, Java .*
 Alternatively, you can add a "shebang" header to your script, make it executable, and execute it directly with `scala-cli`. For example, given this script with a header that invokes `scala-cli`:
 
 ```scala title=HelloScriptSheBang.sc
-#!/usr/bin/env scala-cli
+#!/usr/bin/env -S scala-cli shebang
 
 val sv = scala.util.Properties.versionNumberString
 
@@ -59,7 +59,7 @@ Hello from Scala .*, Java .*
 You can also pass command line arguments to Scala scripts:
 
 ```scala title=ScriptArguments.sc
-#!/usr/bin/env scala-cli
+#!/usr/bin/env -S scala-cli shebang
 println(args(1))
 ```
 

website/docs/reference/cli-options.md

@@ -23,6 +23,7 @@ Aliases: `-q`
 
 Available in commands:
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 
 
 <!-- Automatically generated, DO NOT EDIT MANUALLY -->
@@ -94,6 +95,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -161,6 +163,7 @@ Available in commands:
 - [`package`](./commands.md#package)
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -183,6 +186,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -214,6 +218,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -254,6 +259,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -331,6 +337,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 - [`update`](./commands.md#update)
 - [`version`](./commands.md#version)
@@ -423,6 +430,7 @@ Binary directory
 Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -451,6 +459,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -494,6 +503,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -521,6 +531,7 @@ Available in commands:
 - [`export`](./commands.md#export)
 - [`package`](./commands.md#package)
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 
 
 <!-- Automatically generated, DO NOT EDIT MANUALLY -->
@@ -765,6 +776,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -808,6 +820,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -865,6 +878,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -898,6 +912,7 @@ Available in commands:
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
 - [`setup-ide`](./commands.md#setup-ide)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 
@@ -1002,6 +1017,7 @@ Available in commands:
 - [`package`](./commands.md#package)
 - [`console` / `repl`](./commands.md#console)
 - [`run`](./commands.md#run)
+- [`shebang`](./commands.md#shebang)
 - [`test`](./commands.md#test)
 
 

website/docs/reference/commands.md

@@ -212,6 +212,25 @@ Accepts options:
 - [setup IDE](./cli-options.md#setup-ide-options)
 - [shared](./cli-options.md#shared-options)
 
+## `shebang`
+
+Accepts options:
+- [benchmarking](./cli-options.md#benchmarking-options)
+- [compilation server](./cli-options.md#compilation-server-options)
+- [compile cross](./cli-options.md#compile-cross-options)
+- [coursier](./cli-options.md#coursier-options)
+- [dependency](./cli-options.md#dependency-options)
+- [directories](./cli-options.md#directories-options)
+- [java](./cli-options.md#java-options)
+- [jvm](./cli-options.md#jvm-options)
+- [logging](./cli-options.md#logging-options)
+- [main class](./cli-options.md#main-class-options)
+- [Scala.JS](./cli-options.md#scalajs-options)
+- [Scala Native](./cli-options.md#scala-native-options)
+- [scalac](./cli-options.md#scalac-options)
+- [shared](./cli-options.md#shared-options)
+- [watch](./cli-options.md#watch-options)
+
 ## `test`
 
 Compile and test Scala code