Skip to content

Commit e529440

Browse files
committed
Add --power flag for restricted command in docs
1 parent f571052 commit e529440

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

website/docs/guides/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The configuration options and syntax in `.scala` (and `.sc`) files is likely to
2121
Pass `--help` to any sub-command of `scala-cli` to list its options:
2222
```bash
2323
scala-cli --help
24-
scala-cli package --help
24+
scala-cli --power package --help
2525
```
2626

2727
As an example of command line configuration, one thing you can do with `scala-cli` command line options is to specify the Scala version:

website/docs/release_notes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -608,7 +608,7 @@ Added by [@lwronski](https://github.com/lwronski) in https://github.com/VirtusLa
608608
When running a sequence of commands such as
609609
```bash ignore
610610
$ scala-cli run --native .
611-
$ scala-cli package --native . -o my-app
611+
$ scala-cli --power package --native . -o my-app
612612
```
613613
Scala CLI should cache a Scala Native binary during the first command, so that the second command can just re-use it, rather than generating a binary again. This also fixes the re-use of compilation artifacts between both commands, so that the Scala CLI project isn't re-compiled during the second command either.
614614

@@ -1380,7 +1380,7 @@ by [alexarchambault](https://github.com/alexarchambault).
13801380

13811381
#### Don't write preambles in generated assemblies in the `package` sub-command
13821382

1383-
Passing `--preamble=false` to `scala-cli package --assembly` makes it generate assemblies without a shell preamble. As a
1383+
Passing `--preamble=false` to `scala-cli --power package --assembly` makes it generate assemblies without a shell preamble. As a
13841384
consequence, these assemblies cannot be made executable, but these look more like "standard" JARs, which is required in
13851385
some contexts.
13861386

@@ -1390,10 +1390,10 @@ by [alexarchambault](https://github.com/alexarchambault).
13901390
#### Don't put some dependencies in generated assemblies in the `package` sub-command
13911391

13921392
Some dependencies, alongside all their transitive dependencies, can be excluded from the generated assemblies.
1393-
Pass `--provided org:name` to `scala-cli package --assembly` to remove a dependency, like
1393+
Pass `--provided org:name` to `scala-cli --power package --assembly` to remove a dependency, like
13941394

13951395
```text
1396-
$ scala-cli package SparkJob.scala --assembly --provided org.apache.spark::spark-sql
1396+
$ scala-cli --power package SparkJob.scala --assembly --provided org.apache.spark::spark-sql
13971397
```
13981398

13991399
Note that unlike "provided" dependencies in sbt, and compile-time dependencies in Mill, all transitive dependencies are
@@ -1408,7 +1408,7 @@ by [alexarchambault](https://github.com/alexarchambault).
14081408
#### Experimental Spark capabilities
14091409

14101410
The `package` sub-command now accepts a `--spark` option, to generate assemblies for Spark jobs, ready to be passed
1411-
to `spark-submit`. This option is hidden (not printed in `scala-cli package --help`, only in `--help-full`), and should
1411+
to `spark-submit`. This option is hidden (not printed in `scala-cli --power package --help`, only in `--help-full`), and should
14121412
be considered experimental.
14131413

14141414
See [this document](https://github.com/VirtusLab/scala-cli/blob/410f54c01ac5d9cb046461dce07beb5aa008231e/website/src/pages/spark.md)

website/src/pages/spark.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ object SparkJob {
3131
```
3232

3333
```bash
34-
scala-cli package --spark SparkJob.scala -o spark-job.jar
34+
scala-cli --power package --spark SparkJob.scala -o spark-job.jar
3535
```
3636

3737
```text

0 commit comments

Comments
 (0)