Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dwijnand/sbt-extras
A more featureful runner for sbt, the simple/scala/standard build tool
https://github.com/dwijnand/sbt-extras
Last synced: about 6 hours ago
JSON representation
A more featureful runner for sbt, the simple/scala/standard build tool
- Host: GitHub
- URL: https://github.com/dwijnand/sbt-extras
- Owner: dwijnand
- License: other
- Created: 2011-02-14T18:28:21.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2024-11-06T00:45:03.000Z (4 months ago)
- Last Synced: 2025-02-14T07:38:03.092Z (7 days ago)
- Language: Shell
- Homepage:
- Size: 4.35 MB
- Stars: 912
- Watchers: 35
- Forks: 170
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
sbt: the rebel cut
==================
[](https://github.com/paulp/sbt-extras/actions?query=branch%3Amaster+workflow%3ATest)
[](https://gitter.im/paulp/sbt-extras)
An alternative script for running [sbt](https://github.com/sbt/sbt "sbt home").
It works with sbt 1 projects and (in principle) all earlier versions.
If you're in an sbt project directory, the system will figure out the
required versions of sbt and scala, downloading them if necessary.
## Installation
Put the (self-contained) [sbt script](https://raw.githubusercontent.com/dwijnand/sbt-extras/master/sbt "sbt") somewhere on your path, for instance:
```bash
curl -Ls https://raw.githubusercontent.com/dwijnand/sbt-extras/master/sbt > ~/bin/sbt && chmod 0755 ~/bin/sbt
```
Alternatively you can install with [Homebrew](https://brew.sh/):
```bash
brew install --HEAD dwijnand/extras/sbtx
```
**NOTE**: This will install sbt-extras as `sbtx` (to avoid clashing with the official sbt formula). If you prefer you can `alias sbt=sbtx`.
## Sample usage
sbt -v[erbosely] creating a new project built with the latest scala 2.12.x.
```
% sbt -v -212 -sbt-create about
[addSbt] arg = '++ 2.12.20'
[residual] arg = 'about'
No extra sbt options have been defined
Detected sbt version 1.10.5
Using default jvm options
Detected Java version: 8
# Executing command line:
java
-Xms512m
-Xss2m
-jar
$HOME/.sbt/launchers/1.10.5/sbt-launch.jar
"++ 2.12.20"
about
saving stty: [..]
[warn] No sbt.version set in project/build.properties, base directory: [..]
[info] Setting version to 2.12.20
[info] Loading settings for project global-plugins from [..] ...
[info] Loading global plugins from $HOME/.dotfiles/.sbt/1.0/plugins
[info] Set current project to [..] (in build file:[..])
[info] Setting Scala version to 2.12.20 on 1 projects.
[info] Reapplying settings...
[info] Set current project to [..] (in build file:[..])
[info] This is sbt 1.10.5
[info] The current project is ProjectRef(uri("file:[..]"), "[..]") [..]
[info] The current project is built against Scala 2.12.20
[info] Available Plugins
[..]
[info] sbt, sbt plugins, and build definitions are using Scala 2.12.7
restoring stty: [..]
```
## sbt -h
```
Usage: sbt [options]
Note that options which are passed along to sbt begin with -- whereas
options to this runner use a single dash. Any sbt command can be scheduled
to run first by prefixing the command with --, so --warn, --error and so on
are not special.
-h | -help print this message
-v verbose operation (this runner is chattier)
-d, -w, -q aliases for --debug, --warn, --error (q means quiet)
-x debug this script
-trace display stack traces with a max of frames (default: -1, traces suppressed)
-debug-inc enable debugging log for the incremental compiler
-no-colors disable ANSI color codes
-sbt-create start sbt even if current directory contains no sbt project
-sbt-dir path to global settings/plugins directory (default: ~/.sbt/)
-sbt-boot path to shared boot directory (default: ~/.sbt/boot in 0.11+)
-ivy path to local Ivy repository (default: ~/.ivy2)
-no-share use all local caches; no sharing
-offline put sbt in offline mode
-jvm-debug Turn on JVM debugging, open at the given port.
-batch Disable interactive mode
-prompt Set the sbt prompt; in expr, 's' is the State and 'e' is Extracted
-script Run the specified file as a scala script
# sbt version (default: sbt.version from project/build.properties if present, otherwise 1.10.5)
-sbt-version use the specified version of sbt (default: 1.10.5)
-sbt-force-latest force the use of the latest release of sbt: 1.10.5
-sbt-dev use the latest pre-release version of sbt: 1.10.5
-sbt-jar use the specified jar as the sbt launcher
-sbt-launch-dir directory to hold sbt launchers (default: ~/.sbt/launchers)
-sbt-launch-repo repo url for downloading sbt launcher jar (default: https://repo.scala-sbt.org/scalasbt/maven-releases)
# scala version (default: as chosen by sbt)
-28 use 2.8.2
-29 use 2.9.3
-210 use 2.10.7
-211 use 2.11.12
-212 use 2.12.20
-213 use 2.13.12
-scala-home use the scala build at the specified directory
-scala-version use the specified version of scala
-binary-version use the specified scala version when searching for dependencies
# java version (default: java from PATH, currently java version "1.8.2_202-ea")
-java-home alternate JAVA_HOME
# passing options to the jvm - note it does NOT use JAVA_OPTS due to pollution
# The default set is used if JVM_OPTS is unset and no -jvm-opts file is found
-Xms512m -Xss2m -XX:MaxInlineLevel=18
JVM_OPTS environment variable holding either the jvm args directly, or
the reference to a file containing jvm args if given path is prepended by '@' (e.g. '@/etc/jvmopts')
Note: "@"-file is overridden by local '.jvmopts' or '-jvm-opts' argument.
-jvm-opts file containing jvm args (if not given, .jvmopts in project root is used if present)
-Dkey=val pass -Dkey=val directly to the jvm
-J-X pass option -X directly to the jvm (-J is stripped)
# passing options to sbt, OR to this runner
SBT_OPTS environment variable holding either the sbt args directly, or
the reference to a file containing sbt args if given path is prepended by '@' (e.g. '@/etc/sbtopts')
Note: "@"-file is overridden by local '.sbtopts' or '-sbt-opts' argument.
-sbt-opts file containing sbt args (if not given, .sbtopts in project root is used if present)
-S-X add -X to sbt's scalacOptions (-S is stripped)
# passing options exclusively to this runner
SBTX_OPTS environment variable holding either the sbt-extras args directly, or
the reference to a file containing sbt-extras args if given path is prepended by '@' (e.g. '@/etc/sbtxopts')
Note: "@"-file is overridden by local '.sbtxopts' or '-sbtx-opts' argument.
-sbtx-opts file containing sbt-extras args (if not given, .sbtxopts in project root is used if present)
```