@whittlelabs/sifter 0.28.1 → 0.30.0
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.
- package/README.md +25 -5
- package/bin.js +2016 -26
- package/bin.js.map +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,15 +21,35 @@ Visit Sift's **Settings → Pair a Sifter**. Sift will display a pairing code an
|
|
|
21
21
|
whittle-sifter init --pairing-code=ABCD-1234
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
The Sifter defaults to production
|
|
24
|
+
The Sifter defaults to production. To pair against another Whittle Labs environment, name it with `--profile`: the name selects the backend as well as the directory the pairing lands in.
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
whittle-sifter init
|
|
28
|
-
|
|
29
|
-
|
|
27
|
+
whittle-sifter init --profile stage # keep.stage / jobs.stage
|
|
28
|
+
whittle-sifter init --profile test # keep.test / jobs.test
|
|
29
|
+
whittle-sifter init --profile studio # a dev stack on the Studio
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
The known names are `prod`, `stage`, `test` and `studio`. For any other backend, keep the profile as a label and pass the URLs yourself; a flag always beats the environment it would otherwise have resolved:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
whittle-sifter init --profile my-box \
|
|
36
|
+
--keep-url=http://box.local:3007 \
|
|
37
|
+
--jobs-url=http://box.local:3005
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Whenever a profile or a URL flag is in play, `init` prints what it resolved before it pairs, so a host that has moved is something you see rather than something you debug:
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
Pairing environment
|
|
44
|
+
Profile: stage
|
|
45
|
+
Environment: stage (named by this build)
|
|
46
|
+
Keep: https://keep.stage.whittlelabs.com from the "stage" environment
|
|
47
|
+
Jobs: https://jobs.stage.whittlelabs.com from the "stage" environment
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Once the backend answers, one more line names the page it sent you to, which is its decision and not the CLI's. Add `--json` to get those two facts as JSON objects, one per line.
|
|
51
|
+
|
|
52
|
+
Pairing writes credentials to `~/.sifter/<profile>/config.json` (mode 0600), or `~/.sifter/config.json` for the default profile.
|
|
33
53
|
|
|
34
54
|
## Run
|
|
35
55
|
|