stow/oh-my-zsh/.oh-my-zsh/plugins/sbt/README.md

   1 # sbt plugin
   2
   3 This plugin adds completion for the [sbt, the interactive build tool](https://scala-sbt.org/),
   4 as well as some aliases for common sbt commands.
   5
   6 To use it, add `sbt` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... sbt)
  10 ```
  11
  12 ## Aliases
  13
  14 | Alias | Command               | Description                                                  |
  15 |-------|-----------------------|--------------------------------------------------------------|
  16 | sbc   | `sbt compile`         | Compiles the main sources                                    |
  17 | sbcln | `sbt clean`           | Deletes all generated files                                  |
  18 | sbcc  | `sbt clean compile`   | Deletes generated files, compiles the main sources           |
  19 | sbco  | `sbt console`         | Starts Scala with the compiled sources and all dependencies  |
  20 | sbcq  | `sbt consoleQuick`    | Starts Scala with all dependencies                           |
  21 | sbcp  | `sbt consoleProject`  | Starts Scala with sbt and the build definitions              |
  22 | sbd   | `sbt doc`             | Generates API documentation for Scala source files           |
  23 | sbdc  | `sbt dist:clean`      | Deletes the distribution packages                            |
  24 | sbdi  | `sbt dist`            | Creates the distribution packages                            |
  25 | sbgi  | `sbt genIdea`         | Create Idea project files                                    |
  26 | sbp   | `sbt publish`         | Publishes artifacts to the repository                        |
  27 | sbpl  | `sbt publishLocal`    | Publishes artifacts to the local Ivy repository              |
  28 | sbr   | `sbt run`             | Runs the main class for the project                          |
  29 | sbrm  | `sbt runMain`         | Runs the specified main class for the project                |
  30 | sbu   | `sbt update`          | Resolves and retrieves external dependencies                 |
  31 | sbx   | `sbt test`            | Compiles and runs all tests                                  |
  32 | sba   | `sbt assembly`        | Create a fat JAR with all dependencies                       |