ruflet 0.0.18 → 0.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4c83f1ea707d8ab40ca6e5f8228fa7f73ce4bc2c4348f586b4c6f206288babb2
4
- data.tar.gz: d147a8eb4778f93958649e1fcabdfda7db65d85c5ca4b972e2fe38017533cfb2
3
+ metadata.gz: 78de8fe06ee145d7d509f553ec4905750a27610051ce6da3d1de48dc7b79fb64
4
+ data.tar.gz: 2a6527b6605fb968b7b219503e1049bf8cb0c1cbe3b35ed8c0af5f5ae4237d0a
5
5
  SHA512:
6
- metadata.gz: 5a1b8036b2001449630a70ffcec1fdb319b7c12e5cdd43599d16e0fc12c1dd411f8d27a72172ea285452ff93d134014e56175f11508395b012503c96092b6fce
7
- data.tar.gz: 6d30c57bd94d4f264b81b5346c1160c4bcf75d14aa7b1e80dc6fab0d50cfbe0332421035b287dffad76e82718c28be71e3391004f640a5eecf40da0386aeedd0
6
+ metadata.gz: 1573aa2e047b0f7e6497e4f9a94f4a4fd81ee842d6c9e17221b814e4b289c84882302e06049274d64882ae2b8c833507d7cd86b8cfbc95da06028371544dec3d
7
+ data.tar.gz: 45bc272c824b3a09783e4be9202ce87272ce8f2715bd23e06a6a8db5e3839c3604b70aa629da21a1d98b91daf73beb5e2038b3c68d13cdda3e829b316ad9db23
data/README.md CHANGED
@@ -1,3 +1,56 @@
1
1
  # ruflet
2
2
 
3
- Part of Ruflet monorepo.
3
+ `ruflet` is the command-line package for creating, running, diagnosing, and
4
+ building Ruflet applications.
5
+
6
+ ## Install
7
+
8
+ ```bash
9
+ gem install ruflet
10
+ ```
11
+
12
+ Create a project and run it:
13
+
14
+ ```bash
15
+ ruflet new my_app
16
+ cd my_app
17
+ bundle install
18
+ ruflet run --web
19
+ ```
20
+
21
+ Generated projects include `ruflet_core` and `ruflet_server` as application
22
+ dependencies. Run Ruflet commands directly inside the generated project.
23
+
24
+ ## Commands
25
+
26
+ ```bash
27
+ ruflet new <appname>
28
+ ruflet run [scriptname|path] [--web|--desktop] [--port PORT]
29
+ ruflet debug [scriptname|path]
30
+ ruflet devices
31
+ ruflet emulators
32
+ ruflet doctor [--fix]
33
+ ruflet update [web|desktop|all] [--check] [--force]
34
+ ruflet build <apk|android|ios|aab|web|macos|windows|linux> [--self]
35
+ ruflet install [--device DEVICE_ID]
36
+ ```
37
+
38
+ Commands that create, diagnose, or build a Flutter client compare the cached
39
+ template revision with `AdamMusa/ruflet-template` on GitHub. When `main`
40
+ changes, Ruflet downloads the new template and refreshes its managed
41
+ `build/client` automatically. If GitHub is unavailable, Ruflet keeps using the
42
+ last complete cached template. Use `ruflet doctor --fix` to force a clean
43
+ template download.
44
+
45
+ Desktop and web runs use the completed `prebuild-main` client channel by
46
+ default. Ruflet checks the channel at most once every six hours and downloads
47
+ a new platform build only after every required prebuild job has finished.
48
+ Use `ruflet update --force` for an immediate refresh. Set
49
+ `RUFLET_CLIENT_CHANNEL=stable` to stay on versioned release assets,
50
+ `RUFLET_CLIENT_UPDATE_INTERVAL=0` to check on every run, or
51
+ `RUFLET_CLIENT_AUTO_UPDATE=0` to disable automatic client updates.
52
+
53
+ Run `ruflet install` without `--device` to choose from a numbered list of
54
+ connected devices. Pass `--device DEVICE_ID` to skip the prompt.
55
+
56
+ Run `ruflet help <command>` for all options.