summaryrefslogtreecommitdiffstats
path: root/zsh/oh-my-zsh/plugins/sbt/README.md
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2022-10-03 21:42:20 +0530
committerLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2022-10-03 21:42:20 +0530
commitaf120ab348f2e1a5a39dec035ed9dcf84189a64e (patch)
tree2a3aadd7ce1b7b771dfe3fe7c983569726c8d7ed /zsh/oh-my-zsh/plugins/sbt/README.md
downloaddotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.tar.gz
dotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.tar.bz2
dotfiles-af120ab348f2e1a5a39dec035ed9dcf84189a64e.zip
dotfiles
Diffstat (limited to 'zsh/oh-my-zsh/plugins/sbt/README.md')
-rw-r--r--zsh/oh-my-zsh/plugins/sbt/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/zsh/oh-my-zsh/plugins/sbt/README.md b/zsh/oh-my-zsh/plugins/sbt/README.md
new file mode 100644
index 0000000..f020193
--- /dev/null
+++ b/zsh/oh-my-zsh/plugins/sbt/README.md
@@ -0,0 +1,32 @@
+# sbt plugin
+
+This plugin adds completion for the [sbt, the interactive build tool](https://scala-sbt.org/),
+as well as some aliases for common sbt commands.
+
+To use it, add `sbt` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... sbt)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|-------|-----------------------|--------------------------------------------------------------|
+| sbc | `sbt compile` | Compiles the main sources |
+| sbcln | `sbt clean` | Deletes all generated files |
+| sbcc | `sbt clean compile` | Deletes generated files, compiles the main sources |
+| sbco | `sbt console` | Starts Scala with the compiled sources and all dependencies |
+| sbcq | `sbt consoleQuick` | Starts Scala with all dependencies |
+| sbcp | `sbt consoleProject` | Starts Scala with sbt and the build definitions |
+| sbd | `sbt doc` | Generates API documentation for Scala source files |
+| sbdc | `sbt dist:clean` | Deletes the distribution packages |
+| sbdi | `sbt dist` | Creates the distribution packages |
+| sbgi | `sbt genIdea` | Create Idea project files |
+| sbp | `sbt publish` | Publishes artifacts to the repository |
+| sbpl | `sbt publishLocal` | Publishes artifacts to the local Ivy repository |
+| sbr | `sbt run` | Runs the main class for the project |
+| sbrm | `sbt runMain` | Runs the specified main class for the project |
+| sbu | `sbt update` | Resolves and retrieves external dependencies |
+| sbx | `sbt test` | Compiles and runs all tests |
+| sba | `sbt assembly` | Create a fat JAR with all dependencies |