Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: Add command arguments to the documentation #396

Closed
jiminhsieh opened this issue Sep 5, 2018 · 1 comment · Fixed by #574
Closed

Doc: Add command arguments to the documentation #396

jiminhsieh opened this issue Sep 5, 2018 · 1 comment · Fixed by #574

Comments

@jiminhsieh
Copy link

Maybe we could add a documentation about command arguments at this page - Usage.

opt[String]('b', "branch") action { (b, config) =>
config.copy(ref = Some(Branch(b)))
} text "Resolve a template within a given branch"
opt[String]('t', "tag") action { (t, config) =>
config.copy(ref = Some(Tag(t)))
} text "Resolve a template within a given tag"
opt[String]('d', "directory") action { (d, config) =>
config.copy(directory = Some(d))
} text "Resolve a template within a given directory"
opt[String]('o', "out") action { (o, config) =>
config.copy(out = Some(o))
} text "Output directory"
opt[Unit]('f', "force") action { (_, config) =>
config.copy(forceOverwrite = true)
} text "Force overwrite of any existing files in output directory"

@ches
Copy link
Contributor

ches commented Feb 3, 2019

Agree, especially since the sbt new documentation says this:

Giter8 parameters

You can append Giter8 parameters to the end of the command, so for example to specify a particular branch you can use:

$ sbt new scala/scala-seed.g8 --branch myBranch

And yet, you can't find mention of such parameters anywhere in Giter8 docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

2 participants