You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/docs/cli/configuration.md
+30-23Lines changed: 30 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,8 +37,7 @@ sync:
37
37
- app-id: [PORTALS_APP_ID]
38
38
channel: [CHANNEL]
39
39
directory-name: [DIRECTORY_NAME]
40
-
- app-id: [PORTALS_APP_ID]
41
-
channel: [CHANNEL]
40
+
- file-path: [PATH_TO_DIST_FOLDER]
42
41
directory-name: [DIRECTORY_NAME]
43
42
# ... (add more apps if needed)
44
43
@@ -48,28 +47,34 @@ token: [PORTALS_AUTH_TOKEN]
48
47
### Configuration Options
49
48
50
49
1. **`sync` (List of Apps)**
51
-
52
50
- This is a list of apps that you want to synchronize. Each app is specified as a dictionary with the following attributes.
53
-
54
-
- **`app-id` (Required)**
55
-
56
-
- Type: String
57
-
- Description: The unique identifier for the Appflow application you want to sync.
58
-
59
-
- **`channel` (Optional)**
60
-
61
-
- Type: String
62
-
- Default: `production`
63
-
- Description: The channel of the Appflow application to be synchronized.
64
-
65
-
- **`directory-name` (Optional)**
66
-
- Type: String
67
-
- Default: the `app-id` will be used
68
-
- Description: The directory name where the synchronized app will be saved.
69
-
70
-
2. **`token` (Required)**
51
+
An app can be either a remote app or a local app. A remote app is an app that is hosted on Appflow.
52
+
A local app is an app that is hosted locally on your machine.
53
+
54
+
- Remote Configuration Options
55
+
- **`app-id` (Required)**
56
+
- Type: String
57
+
- Description: The unique identifier for the Appflow application you want to sync.
58
+
59
+
- **`channel` (Optional)**
60
+
- Type: String
61
+
- Default: `production`
62
+
- Description: The channel of the Appflow application to be synchronized.
63
+
64
+
- Local Configuration Options
65
+
- **`file-path` (Required)**
66
+
- Type: String
67
+
- Description: The path to the local build folder to be synchronized.
68
+
69
+
- Common Configuration Options
70
+
- **`directory-name` (Optional)**
71
+
- Type: String
72
+
- Default: the `app-id` or the last path component of `file-path` will be used
73
+
- Description: The directory name where the synchronized app will be saved.
74
+
75
+
2. **`token` (Optional)**
71
76
- Type: String
72
-
- Description: The authentication token required to access Portals and perform sync operations. This token should be kept secure, as it provides access to your Appflow deployments.
77
+
- Description: The authentication token required to access Portals and perform sync operations. This token should be kept secure, as it provides access to your Appflow deployments. This is required if you want to sync a remote app.
73
78
74
79
### Usage
75
80
@@ -90,11 +95,13 @@ token: [PORTALS_AUTH_TOKEN]
90
95
directory-name: home
91
96
- app-id: a81b2440
92
97
directory-name: cart
98
+
- file-path: /Users/username/my-app/dist
99
+
directory-name: my-app
93
100
```
94
101
95
102
2. **`token` Section**
96
103
97
-
- In the `token` section, provide your Appflow Personal Access Token.
104
+
- In the `token` section, provide your Appflow Personal Access Token if you have remote applications.
0 commit comments