Skip to content

Commit 15cd9e5

Browse files
committedMar 19, 2025·
update readme help pages
1 parent 5d7d3a0 commit 15cd9e5

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed
 

‎README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -86,20 +86,18 @@ To make your package or platform available in roc-start, simply make a pull requ
8686
A simple CLI tool for starting or upgrading roc projects. Specify your platform and packages by name, and roc-start will create a new .roc file or update an existing one with the either the versions you specify, or the latest releases. If no arguments are specified, the TUI app will be launched instead.
8787
8888
Usage:
89-
roc-start -v/--verbosity STR --theme STR [options]
89+
roc-start -v/--verbosity STR [options]
9090
roc-start <COMMAND>
9191
9292
Commands:
93-
tui Use the TUI app to browse and search for platforms and packages.
94-
update Update the platform and package repositories and scripts. Update all, or specify which to update.
93+
update Update the platform and package repositories and plugins. Update all, or specify which to update.
9594
app Create a new roc app with the specified name, platform, and packages.
9695
package Create a new roc package main file with all specified packages dependencies.
9796
upgrade Upgrade the platform and/or packages in an app or package
9897
config Configure the default settings for the roc-start CLI tool.
9998
10099
Options:
101100
-v STR, --verbosity STR Set the verbosity level to one of: verbose, quiet, or silent.
102-
--theme STR Set the color theme to use one of: roc-mono, roc-c16, roc, warn-only, no-color, coffee-cat-dark, coffee-cat-light.
103101
-h, --help Show this help page.
104102
-V, --version Show the version.
105103
```
@@ -116,6 +114,7 @@ Arguments:
116114
117115
Options:
118116
-f, --force Force overwrite of existing file.
117+
--no-plugin Force roc-start to use fallback generation insteaad of platform specific plugin.
119118
-o STR, --out STR The name of the output file (Defaults to `main.roc`). Extension is not required.
120119
-p STR, --platform STR The platform to use (Defaults to `basic-cli=latest` unless otherwise configured). Set the version with `--platform <platform>:<version>`.
121120
-h, --help Show this help page.
@@ -139,6 +138,23 @@ Options:
139138
-V, --version Show the version.
140139
```
141140

141+
### roc-start update --help
142+
```
143+
Update the platform and package repositories and plugins. Update all (excluding installation), or specify which to update.
144+
145+
Usage:
146+
roc-start update [options]
147+
148+
Options:
149+
-k, --packages Update the package repositories.
150+
-f, --platforms Update the platform repositories.
151+
-s, --plugins Update the platform plugins.
152+
-t, --themes Update the available color themes.
153+
-i, --install Install the latest version of roc-start.
154+
-h, --help Show this help page.
155+
-V, --version Show the version.
156+
```
157+
142158
<!-- [roc_badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fpastebin.com%2Fraw%2FGcfjHKzb -->
143159
[roc_badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fpastebin.com%2Fraw%2FcFzuCCd7
144160
[roc_link]: https://github.com/roc-lang/roc

0 commit comments

Comments
 (0)
Please sign in to comment.