@embeddables/cli 0.4.3 → 0.4.4
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 +11 -14
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -25,15 +25,12 @@ npm install -g @embeddables/cli
|
|
|
25
25
|
## Quick Start
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
#
|
|
29
|
-
embeddables init
|
|
30
|
-
|
|
31
|
-
# Install dependencies
|
|
32
|
-
npm install
|
|
33
|
-
|
|
34
|
-
# Login to your Embeddables account
|
|
28
|
+
# Login to your Embeddables account (this applies gobally)
|
|
35
29
|
embeddables login
|
|
36
30
|
|
|
31
|
+
# Initialize a new project, from within a new folder (will ask for your Embeddables project ID if not skipped)
|
|
32
|
+
embeddables init
|
|
33
|
+
|
|
37
34
|
# Pull an embeddable (shows a list to choose from when logged in)
|
|
38
35
|
embeddables pull
|
|
39
36
|
|
|
@@ -46,19 +43,19 @@ This creates the following structure in your repo:
|
|
|
46
43
|
```
|
|
47
44
|
embeddables/
|
|
48
45
|
<embeddable-id>/
|
|
49
|
-
pages/
|
|
50
|
-
styles/
|
|
51
|
-
computed-fields/
|
|
52
|
-
actions/
|
|
53
|
-
config.json
|
|
54
|
-
.generated/
|
|
46
|
+
pages/ # TSX page files
|
|
47
|
+
styles/ # CSS styles
|
|
48
|
+
computed-fields/ # Custom computed field logic
|
|
49
|
+
actions/ # Data output actions
|
|
50
|
+
config.json # Embeddable configuration
|
|
51
|
+
.generated/ # Compiled JSON output
|
|
55
52
|
```
|
|
56
53
|
|
|
57
54
|
## Commands
|
|
58
55
|
|
|
59
56
|
### `embeddables init`
|
|
60
57
|
|
|
61
|
-
Initialize a new Embeddables project. Creates `
|
|
58
|
+
Initialize a new Embeddables project. Creates `embeddables.json`, `.gitignore`, `.types/` (type stubs), `tsconfig.json` (if missing), and an `embeddables/` directory.
|
|
62
59
|
|
|
63
60
|
If you're logged in and don't use `--yes`, you'll see an interactive list of your projects to choose from. Otherwise you can enter a project ID manually or skip.
|
|
64
61
|
|