@goodfolder/cli 0.1.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.
Files changed (4) hide show
  1. package/LICENSE +661 -0
  2. package/README.md +31 -0
  3. package/dist/index.js +2416 -0
  4. package/package.json +33 -0
package/README.md ADDED
@@ -0,0 +1,31 @@
1
+ # GoodFolder CLI
2
+
3
+ The GoodFolder CLI works on the computer that holds the folder. It connects a
4
+ folder, makes Saves, carries work to another approved computer, and lets you
5
+ return to an earlier Save.
6
+
7
+ Install it with:
8
+
9
+ ```bash
10
+ npm install -g @goodfolder/cli
11
+ ```
12
+
13
+ For GoodFolder Hosted, sign in and start a trial before connecting a folder.
14
+ Then, from the folder you want to protect:
15
+
16
+ ```bash
17
+ goodfolder connect
18
+ ```
19
+
20
+ The command opens a browser once so you can approve that computer.
21
+
22
+ ## Running your own server
23
+
24
+ Point the first connection at your own GoodFolder server with `GF_API_URL`:
25
+
26
+ ```bash
27
+ GF_API_URL=http://localhost:4100 goodfolder connect ~/some-folder
28
+ ```
29
+
30
+ A folder remembers the server it was set up against, so you only need the
31
+ variable for that first connection.