@factorialco/fcode-cli 1.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 (234) hide show
  1. package/README.md +1021 -0
  2. package/bin/dev +17 -0
  3. package/bin/dev.cmd +3 -0
  4. package/bin/run +7 -0
  5. package/bin/run.cmd +3 -0
  6. package/dist/commands/add.d.ts +6 -0
  7. package/dist/commands/add.js +22 -0
  8. package/dist/commands/clone.d.ts +26 -0
  9. package/dist/commands/clone.js +177 -0
  10. package/dist/commands/dependencies/add.d.ts +9 -0
  11. package/dist/commands/dependencies/add.js +13 -0
  12. package/dist/commands/dependencies/install.d.ts +14 -0
  13. package/dist/commands/dependencies/install.js +44 -0
  14. package/dist/commands/dependencies/pull.d.ts +12 -0
  15. package/dist/commands/dependencies/pull.js +14 -0
  16. package/dist/commands/dependencies/push.d.ts +12 -0
  17. package/dist/commands/dependencies/push.js +14 -0
  18. package/dist/commands/dependencies/reset.d.ts +9 -0
  19. package/dist/commands/dependencies/reset.js +13 -0
  20. package/dist/commands/dependencies/status.d.ts +9 -0
  21. package/dist/commands/dependencies/status.js +13 -0
  22. package/dist/commands/http.d.ts +22 -0
  23. package/dist/commands/http.js +272 -0
  24. package/dist/commands/login.d.ts +18 -0
  25. package/dist/commands/login.js +62 -0
  26. package/dist/commands/logout.d.ts +10 -0
  27. package/dist/commands/logout.js +34 -0
  28. package/dist/commands/modules/add.d.ts +9 -0
  29. package/dist/commands/modules/add.js +13 -0
  30. package/dist/commands/modules/pull.d.ts +13 -0
  31. package/dist/commands/modules/pull.js +43 -0
  32. package/dist/commands/modules/push.d.ts +13 -0
  33. package/dist/commands/modules/push.js +35 -0
  34. package/dist/commands/modules/remove.d.ts +9 -0
  35. package/dist/commands/modules/remove.js +19 -0
  36. package/dist/commands/modules/reset.d.ts +9 -0
  37. package/dist/commands/modules/reset.js +13 -0
  38. package/dist/commands/modules/status.d.ts +11 -0
  39. package/dist/commands/modules/status.js +40 -0
  40. package/dist/commands/pre-debug.d.ts +20 -0
  41. package/dist/commands/pre-debug.js +120 -0
  42. package/dist/commands/process-metadata.d.ts +18 -0
  43. package/dist/commands/process-metadata.js +63 -0
  44. package/dist/commands/processes/add.d.ts +9 -0
  45. package/dist/commands/processes/add.js +13 -0
  46. package/dist/commands/processes/install-dependencies.d.ts +14 -0
  47. package/dist/commands/processes/install-dependencies.js +30 -0
  48. package/dist/commands/processes/pull.d.ts +13 -0
  49. package/dist/commands/processes/pull.js +47 -0
  50. package/dist/commands/processes/push.d.ts +13 -0
  51. package/dist/commands/processes/push.js +39 -0
  52. package/dist/commands/processes/remove.d.ts +9 -0
  53. package/dist/commands/processes/remove.js +19 -0
  54. package/dist/commands/processes/reset.d.ts +9 -0
  55. package/dist/commands/processes/reset.js +13 -0
  56. package/dist/commands/processes/status.d.ts +11 -0
  57. package/dist/commands/processes/status.js +58 -0
  58. package/dist/commands/pull.d.ts +9 -0
  59. package/dist/commands/pull.js +32 -0
  60. package/dist/commands/push.d.ts +9 -0
  61. package/dist/commands/push.js +29 -0
  62. package/dist/commands/remote/add.d.ts +10 -0
  63. package/dist/commands/remote/add.js +32 -0
  64. package/dist/commands/remote/list.d.ts +7 -0
  65. package/dist/commands/remote/list.js +33 -0
  66. package/dist/commands/remote/set.d.ts +10 -0
  67. package/dist/commands/remote/set.js +28 -0
  68. package/dist/commands/reset.d.ts +6 -0
  69. package/dist/commands/reset.js +19 -0
  70. package/dist/commands/run.d.ts +16 -0
  71. package/dist/commands/run.js +56 -0
  72. package/dist/commands/runtime-env.d.ts +12 -0
  73. package/dist/commands/runtime-env.js +42 -0
  74. package/dist/commands/settings/get.d.ts +12 -0
  75. package/dist/commands/settings/get.js +67 -0
  76. package/dist/commands/settings/remove.d.ts +9 -0
  77. package/dist/commands/settings/remove.js +35 -0
  78. package/dist/commands/settings/set.d.ts +10 -0
  79. package/dist/commands/settings/set.js +39 -0
  80. package/dist/commands/setup-debug.d.ts +12 -0
  81. package/dist/commands/setup-debug.js +118 -0
  82. package/dist/commands/status.d.ts +6 -0
  83. package/dist/commands/status.js +22 -0
  84. package/dist/commands/team/pull.d.ts +8 -0
  85. package/dist/commands/team/pull.js +23 -0
  86. package/dist/commands/team/push.d.ts +11 -0
  87. package/dist/commands/team/push.js +41 -0
  88. package/dist/commands/team/status.d.ts +8 -0
  89. package/dist/commands/team/status.js +40 -0
  90. package/dist/commands/test/scaffold.d.ts +9 -0
  91. package/dist/commands/test/scaffold.js +61 -0
  92. package/dist/commands/test.d.ts +13 -0
  93. package/dist/commands/test.js +72 -0
  94. package/dist/commands/variables/add.d.ts +12 -0
  95. package/dist/commands/variables/add.js +21 -0
  96. package/dist/commands/variables/pull.d.ts +12 -0
  97. package/dist/commands/variables/pull.js +14 -0
  98. package/dist/commands/variables/push.d.ts +12 -0
  99. package/dist/commands/variables/push.js +14 -0
  100. package/dist/commands/variables/remove.d.ts +9 -0
  101. package/dist/commands/variables/remove.js +19 -0
  102. package/dist/commands/variables/reset.d.ts +9 -0
  103. package/dist/commands/variables/reset.js +13 -0
  104. package/dist/commands/variables/status.d.ts +12 -0
  105. package/dist/commands/variables/status.js +58 -0
  106. package/dist/config/global.d.ts +15 -0
  107. package/dist/config/global.js +77 -0
  108. package/dist/config/index.d.ts +14 -0
  109. package/dist/config/index.js +44 -0
  110. package/dist/config/remote.d.ts +15 -0
  111. package/dist/config/remote.js +60 -0
  112. package/dist/config/settings.d.ts +16 -0
  113. package/dist/config/settings.js +54 -0
  114. package/dist/config/workspace.d.ts +28 -0
  115. package/dist/config/workspace.js +158 -0
  116. package/dist/core/commands/api-client-command.d.ts +6 -0
  117. package/dist/core/commands/api-client-command.js +30 -0
  118. package/dist/core/commands/base-command.d.ts +11 -0
  119. package/dist/core/commands/base-command.js +61 -0
  120. package/dist/core/commands/dependency-command.d.ts +5 -0
  121. package/dist/core/commands/dependency-command.js +16 -0
  122. package/dist/core/commands/modules-command.d.ts +7 -0
  123. package/dist/core/commands/modules-command.js +18 -0
  124. package/dist/core/commands/processes-command.d.ts +8 -0
  125. package/dist/core/commands/processes-command.js +27 -0
  126. package/dist/core/commands/resource-command.d.ts +24 -0
  127. package/dist/core/commands/resource-command.js +92 -0
  128. package/dist/core/commands/variables-command.d.ts +5 -0
  129. package/dist/core/commands/variables-command.js +16 -0
  130. package/dist/core/dependencies/env-dependencies-command.d.ts +19 -0
  131. package/dist/core/dependencies/env-dependencies-command.js +70 -0
  132. package/dist/core/dependencies/env-process-dependencies-command.d.ts +15 -0
  133. package/dist/core/dependencies/env-process-dependencies-command.js +78 -0
  134. package/dist/core/dependencies/javascript-env-dependencies.d.ts +8 -0
  135. package/dist/core/dependencies/javascript-env-dependencies.js +77 -0
  136. package/dist/core/dependencies/python-env-dependencies.d.ts +9 -0
  137. package/dist/core/dependencies/python-env-dependencies.js +91 -0
  138. package/dist/core/errors.d.ts +55 -0
  139. package/dist/core/errors.js +144 -0
  140. package/dist/core/executors/execution-task.d.ts +29 -0
  141. package/dist/core/executors/execution-task.js +139 -0
  142. package/dist/core/executors/javascript-execution-task.d.ts +13 -0
  143. package/dist/core/executors/javascript-execution-task.js +618 -0
  144. package/dist/core/executors/python/context.d.ts +2 -0
  145. package/dist/core/executors/python/context.js +3 -0
  146. package/dist/core/executors/python/datastore.d.ts +2 -0
  147. package/dist/core/executors/python/datastore.js +4 -0
  148. package/dist/core/executors/python-execution-task.d.ts +11 -0
  149. package/dist/core/executors/python-execution-task.js +173 -0
  150. package/dist/core/executors/source-code-sanitizer.d.ts +4 -0
  151. package/dist/core/executors/source-code-sanitizer.js +45 -0
  152. package/dist/core/resource-merger.d.ts +14 -0
  153. package/dist/core/resource-merger.js +155 -0
  154. package/dist/core/resource-pusher.d.ts +12 -0
  155. package/dist/core/resource-pusher.js +133 -0
  156. package/dist/core/resource-repository.d.ts +8 -0
  157. package/dist/core/resource-repository.js +2 -0
  158. package/dist/core/types.d.ts +290 -0
  159. package/dist/core/types.js +238 -0
  160. package/dist/core/utils/dependencies.d.ts +5 -0
  161. package/dist/core/utils/dependencies.js +82 -0
  162. package/dist/core/utils/variables.d.ts +4 -0
  163. package/dist/core/utils/variables.js +10 -0
  164. package/dist/hooks/init/auth.d.ts +3 -0
  165. package/dist/hooks/init/auth.js +28 -0
  166. package/dist/hooks/init/update.d.ts +3 -0
  167. package/dist/hooks/init/update.js +42 -0
  168. package/dist/index.d.ts +1 -0
  169. package/dist/index.js +4 -0
  170. package/dist/repositories/process.d.ts +36 -0
  171. package/dist/repositories/process.js +339 -0
  172. package/dist/repositories/programming-language-manifest.d.ts +17 -0
  173. package/dist/repositories/programming-language-manifest.js +95 -0
  174. package/dist/repositories/resource.d.ts +29 -0
  175. package/dist/repositories/resource.js +79 -0
  176. package/dist/repositories/script-library.d.ts +28 -0
  177. package/dist/repositories/script-library.js +164 -0
  178. package/dist/repositories/team.d.ts +23 -0
  179. package/dist/repositories/team.js +74 -0
  180. package/dist/repositories/variable.d.ts +26 -0
  181. package/dist/repositories/variable.js +174 -0
  182. package/dist/runtime/executor.js +87 -0
  183. package/dist/runtime/executor.py +81 -0
  184. package/dist/runtime/libs/node/fcode/index.js +1 -0
  185. package/dist/runtime/libs/python/fcode/__init__.py +75 -0
  186. package/dist/runtime/libs/python/fcode/context.py +98 -0
  187. package/dist/runtime/libs/python/fcode/datastore.py +35 -0
  188. package/dist/runtime/libs/python/fcode/schedule.py +45 -0
  189. package/dist/runtime/libs/python/fcode/storage.py +271 -0
  190. package/dist/runtime/libs/python/fcode/variables.py +102 -0
  191. package/dist/services/auth-service.d.ts +12 -0
  192. package/dist/services/auth-service.js +114 -0
  193. package/dist/services/credential-prompter.d.ts +6 -0
  194. package/dist/services/credential-prompter.js +60 -0
  195. package/dist/services/fcode-graphql-client.d.ts +45 -0
  196. package/dist/services/fcode-graphql-client.js +721 -0
  197. package/dist/services/http-server.d.ts +3 -0
  198. package/dist/services/http-server.js +17 -0
  199. package/dist/services/oauth-browser-service.d.ts +9 -0
  200. package/dist/services/oauth-browser-service.js +164 -0
  201. package/dist/services/process-parameters-sampler.d.ts +2 -0
  202. package/dist/services/process-parameters-sampler.js +41 -0
  203. package/dist/services/process-runner.d.ts +22 -0
  204. package/dist/services/process-runner.js +97 -0
  205. package/dist/services/resource-checker.d.ts +8 -0
  206. package/dist/services/resource-checker.js +82 -0
  207. package/dist/services/test-runner.d.ts +17 -0
  208. package/dist/services/test-runner.js +228 -0
  209. package/dist/utils/canonical-hash.d.ts +9 -0
  210. package/dist/utils/canonical-hash.js +30 -0
  211. package/dist/utils/cli/index.d.ts +14 -0
  212. package/dist/utils/cli/index.js +50 -0
  213. package/dist/utils/cli/screen.d.ts +2 -0
  214. package/dist/utils/cli/screen.js +25 -0
  215. package/dist/utils/cli/styled/table.d.ts +23 -0
  216. package/dist/utils/cli/styled/table.js +272 -0
  217. package/dist/utils/colorize-resource.d.ts +1 -0
  218. package/dist/utils/colorize-resource.js +7 -0
  219. package/dist/utils/env-utils.d.ts +2 -0
  220. package/dist/utils/env-utils.js +16 -0
  221. package/dist/utils/file-utils.d.ts +11 -0
  222. package/dist/utils/file-utils.js +33 -0
  223. package/dist/utils/filenamify.d.ts +4 -0
  224. package/dist/utils/filenamify.js +73 -0
  225. package/dist/utils/gitignore.d.ts +17 -0
  226. package/dist/utils/gitignore.js +60 -0
  227. package/dist/utils/promise.d.ts +4 -0
  228. package/dist/utils/promise.js +38 -0
  229. package/dist/utils/url-utils.d.ts +2 -0
  230. package/dist/utils/url-utils.js +10 -0
  231. package/dist/utils/variable-warnings.d.ts +8 -0
  232. package/dist/utils/variable-warnings.js +38 -0
  233. package/oclif.manifest.json +1783 -0
  234. package/package.json +129 -0
package/README.md ADDED
@@ -0,0 +1,1021 @@
1
+ # Factorial Code Command Line Interface
2
+
3
+ Factorial Code is the the all-in-one platform that connects your services and APIs in the most agile way. You may discover every single piece of the Factorial Code Universe in the following links:
4
+
5
+ - [Factorial Developer Portal](https://code.factorial.dev)
6
+ - [Factorial Code Docs](https://code.factorial.dev/docs)
7
+
8
+ Factorial Code provides both a Graphic User Interface (GUI), accessible at https://code.factorial.dev, and a CLI for interacting with Factorial Code Cloud.
9
+
10
+ The Factorial Code Command Line Interface facilitates interaction with Factorial Code Cloud directly from your local workstation's command line. It's particularly useful if you prefer developing and testing processes' source code locally rather than using the web IDE of Factorial Code Cloud.
11
+
12
+ See full documentation at [https://code.factorial.dev/docs/cli/](https://code.factorial.dev/docs/cli/).
13
+
14
+ For a guide on writing and running tests for your processes, see [TEST.md](TEST.md).
15
+
16
+ ## Usage
17
+ <!-- usage -->
18
+ ```sh-session
19
+ $ npm install -g @factorialco/fcode-cli
20
+ $ fcode COMMAND
21
+ running command...
22
+ $ fcode (--version)
23
+ @factorialco/fcode-cli/1.1.0 linux-x64 node-v22.22.3
24
+ $ fcode --help [COMMAND]
25
+ USAGE
26
+ $ fcode COMMAND
27
+ ...
28
+ ```
29
+ <!-- usagestop -->
30
+
31
+ ## Commands
32
+ <!-- commands -->
33
+ * [`fcode add`](#fcode-add)
34
+ * [`fcode clone [TEAM]`](#fcode-clone-team)
35
+ * [`fcode dependencies:add [RESOURCESLUG]`](#fcode-dependenciesadd-resourceslug)
36
+ * [`fcode dependencies:install [PROGRAMMINGLANGUAGE]`](#fcode-dependenciesinstall-programminglanguage)
37
+ * [`fcode dependencies:pull [RESOURCESLUG]`](#fcode-dependenciespull-resourceslug)
38
+ * [`fcode dependencies:push [RESOURCESLUG]`](#fcode-dependenciespush-resourceslug)
39
+ * [`fcode dependencies:reset [RESOURCESLUG]`](#fcode-dependenciesreset-resourceslug)
40
+ * [`fcode dependencies:status [RESOURCESLUG]`](#fcode-dependenciesstatus-resourceslug)
41
+ * [`fcode help [COMMAND]`](#fcode-help-command)
42
+ * [`fcode http`](#fcode-http)
43
+ * [`fcode login`](#fcode-login)
44
+ * [`fcode logout`](#fcode-logout)
45
+ * [`fcode modules:add [RESOURCESLUG]`](#fcode-modulesadd-resourceslug)
46
+ * [`fcode modules:pull [RESOURCESLUG]`](#fcode-modulespull-resourceslug)
47
+ * [`fcode modules:push [RESOURCESLUG]`](#fcode-modulespush-resourceslug)
48
+ * [`fcode modules:remove [RESOURCESLUG]`](#fcode-modulesremove-resourceslug)
49
+ * [`fcode modules:reset [RESOURCESLUG]`](#fcode-modulesreset-resourceslug)
50
+ * [`fcode modules:status [RESOURCESLUG]`](#fcode-modulesstatus-resourceslug)
51
+ * [`fcode processes:add [RESOURCESLUG]`](#fcode-processesadd-resourceslug)
52
+ * [`fcode processes:install-dependencies [RESOURCESLUG]`](#fcode-processesinstall-dependencies-resourceslug)
53
+ * [`fcode processes:pull [RESOURCESLUG]`](#fcode-processespull-resourceslug)
54
+ * [`fcode processes:push [RESOURCESLUG]`](#fcode-processespush-resourceslug)
55
+ * [`fcode processes:remove [RESOURCESLUG]`](#fcode-processesremove-resourceslug)
56
+ * [`fcode processes:reset [RESOURCESLUG]`](#fcode-processesreset-resourceslug)
57
+ * [`fcode processes:status [RESOURCESLUG]`](#fcode-processesstatus-resourceslug)
58
+ * [`fcode pull`](#fcode-pull)
59
+ * [`fcode push`](#fcode-push)
60
+ * [`fcode remote:add [TEAM]`](#fcode-remoteadd-team)
61
+ * [`fcode remote:list`](#fcode-remotelist)
62
+ * [`fcode remote:set [TEAM]`](#fcode-remoteset-team)
63
+ * [`fcode reset`](#fcode-reset)
64
+ * [`fcode run SLUG`](#fcode-run-slug)
65
+ * [`fcode settings:get [KEY]`](#fcode-settingsget-key)
66
+ * [`fcode settings:remove KEY`](#fcode-settingsremove-key)
67
+ * [`fcode settings:set KEY VALUE`](#fcode-settingsset-key-value)
68
+ * [`fcode setup-debug`](#fcode-setup-debug)
69
+ * [`fcode status`](#fcode-status)
70
+ * [`fcode team:pull`](#fcode-teampull)
71
+ * [`fcode team:push`](#fcode-teampush)
72
+ * [`fcode team:status`](#fcode-teamstatus)
73
+ * [`fcode test [SLUG]`](#fcode-test-slug)
74
+ * [`fcode test:scaffold SLUG`](#fcode-testscaffold-slug)
75
+ * [`fcode variables:add [RESOURCESLUG]`](#fcode-variablesadd-resourceslug)
76
+ * [`fcode variables:pull [RESOURCESLUG]`](#fcode-variablespull-resourceslug)
77
+ * [`fcode variables:push [RESOURCESLUG]`](#fcode-variablespush-resourceslug)
78
+ * [`fcode variables:remove [RESOURCESLUG]`](#fcode-variablesremove-resourceslug)
79
+ * [`fcode variables:reset [RESOURCESLUG]`](#fcode-variablesreset-resourceslug)
80
+ * [`fcode variables:status [RESOURCESLUG]`](#fcode-variablesstatus-resourceslug)
81
+
82
+ ## `fcode add`
83
+
84
+ Keeps track of new local components
85
+
86
+ ```
87
+ USAGE
88
+ $ fcode add
89
+
90
+ DESCRIPTION
91
+ Keeps track of new local components
92
+
93
+ EXAMPLES
94
+ $ fcode add
95
+ ```
96
+
97
+ ## `fcode clone [TEAM]`
98
+
99
+ Clone team workspace from cloud
100
+
101
+ ```
102
+ USAGE
103
+ $ fcode clone [TEAM] [--skipSkillsSetup]
104
+
105
+ ARGUMENTS
106
+ [TEAM] Team name
107
+
108
+ FLAGS
109
+ --skipSkillsSetup Skip installation of the Factorial Code agent skills
110
+
111
+ DESCRIPTION
112
+ Clone team workspace from cloud
113
+
114
+ EXAMPLES
115
+ $ fcode clone
116
+
117
+ $ fcode clone [team]
118
+ ```
119
+
120
+ ## `fcode dependencies:add [RESOURCESLUG]`
121
+
122
+ Keeps track of dependencies
123
+
124
+ ```
125
+ USAGE
126
+ $ fcode dependencies:add [RESOURCESLUG]
127
+
128
+ ARGUMENTS
129
+ [RESOURCESLUG] Resource slug
130
+
131
+ DESCRIPTION
132
+ Keeps track of dependencies
133
+
134
+ EXAMPLES
135
+ $ fcode dependencies:add
136
+ ```
137
+
138
+ ## `fcode dependencies:install [PROGRAMMINGLANGUAGE]`
139
+
140
+ Install Factorial Code dependencies
141
+
142
+ ```
143
+ USAGE
144
+ $ fcode dependencies:install [PROGRAMMINGLANGUAGE] [-c] [-r] [-f]
145
+
146
+ ARGUMENTS
147
+ [PROGRAMMINGLANGUAGE] (all|javascript|python) [default: all] Programming language
148
+
149
+ FLAGS
150
+ -c, --check Check if is needed to install dependencies
151
+ -f, --force Force dependencies installation even if they are already installed
152
+ -r, --reset Remove all existing dependencies before installing
153
+
154
+ DESCRIPTION
155
+ Install Factorial Code dependencies
156
+
157
+ EXAMPLES
158
+ $ fcode dependencies:install [programmingLanguage]
159
+ ```
160
+
161
+ ## `fcode dependencies:pull [RESOURCESLUG]`
162
+
163
+ Fetch all dependencies from cloud and save them locally
164
+
165
+ ```
166
+ USAGE
167
+ $ fcode dependencies:pull [RESOURCESLUG] [-f]
168
+
169
+ ARGUMENTS
170
+ [RESOURCESLUG] Resource slug
171
+
172
+ FLAGS
173
+ -f, --force Force command
174
+
175
+ DESCRIPTION
176
+ Fetch all dependencies from cloud and save them locally
177
+
178
+ EXAMPLES
179
+ $ fcode dependencies:pull
180
+ ```
181
+
182
+ ## `fcode dependencies:push [RESOURCESLUG]`
183
+
184
+ Update cloud dependencies with local ones
185
+
186
+ ```
187
+ USAGE
188
+ $ fcode dependencies:push [RESOURCESLUG] [-f]
189
+
190
+ ARGUMENTS
191
+ [RESOURCESLUG] Resource slug
192
+
193
+ FLAGS
194
+ -f, --force Force command
195
+
196
+ DESCRIPTION
197
+ Update cloud dependencies with local ones
198
+
199
+ EXAMPLES
200
+ $ fcode dependencies:push
201
+ ```
202
+
203
+ ## `fcode dependencies:reset [RESOURCESLUG]`
204
+
205
+ Reset dependencies with contents from current remote
206
+
207
+ ```
208
+ USAGE
209
+ $ fcode dependencies:reset [RESOURCESLUG]
210
+
211
+ ARGUMENTS
212
+ [RESOURCESLUG] Resource slug
213
+
214
+ DESCRIPTION
215
+ Reset dependencies with contents from current remote
216
+
217
+ EXAMPLES
218
+ $ fcode dependencies:reset
219
+ ```
220
+
221
+ ## `fcode dependencies:status [RESOURCESLUG]`
222
+
223
+ List all dependencies status
224
+
225
+ ```
226
+ USAGE
227
+ $ fcode dependencies:status [RESOURCESLUG]
228
+
229
+ ARGUMENTS
230
+ [RESOURCESLUG] Resource slug
231
+
232
+ DESCRIPTION
233
+ List all dependencies status
234
+
235
+ EXAMPLES
236
+ $ fcode dependencies:status
237
+ ```
238
+
239
+ ## `fcode help [COMMAND]`
240
+
241
+ Display help for fcode.
242
+
243
+ ```
244
+ USAGE
245
+ $ fcode help [COMMAND...] [-n]
246
+
247
+ ARGUMENTS
248
+ [COMMAND...] Command to show help for.
249
+
250
+ FLAGS
251
+ -n, --nested-commands Include all nested commands in the output.
252
+
253
+ DESCRIPTION
254
+ Display help for fcode.
255
+ ```
256
+
257
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.50/src/commands/help.ts)_
258
+
259
+ ## `fcode http`
260
+
261
+ Start a local HTTP server to trigger Factorial Code processes via webhooks and expose forms schema
262
+
263
+ ```
264
+ USAGE
265
+ $ fcode http [-P <value>] [-l DEBUG|INFO|WARNING|ERROR] [--auth-user <value>] [--auth-password <value>]
266
+ [-j]
267
+
268
+ FLAGS
269
+ -P, --port=<value> [default: 3000] Port to listen on
270
+ -j, --jsonLogs Output process logs as newline-delimited JSON (NDJSON)
271
+ -l, --logLevel=<option> [default: DEBUG] Log level to use in process executions
272
+ <options: DEBUG|INFO|WARNING|ERROR>
273
+ --auth-password=<value> Basic auth password
274
+ --auth-user=<value> Basic auth username
275
+
276
+ DESCRIPTION
277
+ Start a local HTTP server to trigger Factorial Code processes via webhooks and expose forms schema
278
+
279
+ EXAMPLES
280
+ $ fcode http
281
+
282
+ $ fcode http --port 8080
283
+
284
+ $ fcode http --auth-user admin --auth-password secret
285
+ ```
286
+
287
+ ## `fcode login`
288
+
289
+ Login with your Factorial Code credentials (browser OAuth or email/password)
290
+
291
+ ```
292
+ USAGE
293
+ $ fcode login [-u <value>] [-a <value>] [-e <value>] [-p <value>] [-c <value>] [-s <value>] [-t <value>]
294
+ [-x]
295
+
296
+ FLAGS
297
+ -a, --authUrl=<value> Factorial Code Auth endpoint (including realm, ie:
298
+ https://code.factorial.dev/auth/realms/fcode)). Only needed if auth domain is different
299
+ than used cloud endpoint
300
+ -c, --clientId=<value> Client ID (for oauth, to be used with Client Secret)
301
+ -e, --email=<value> Email (to be used with password)
302
+ -p, --password=<value> Password (to be used with email)
303
+ -s, --clientSecret=<value> Client Secret (for oauth, to be used with Client ID)
304
+ -t, --accessToken=<value> Access Token (to be used instead of email and password)
305
+ -u, --url=<value> [default: https://code.factorial.dev/platform] Factorial Code Cloud endpoint
306
+ -x, --prompt Prompt for email and password (instead of opening browser)
307
+
308
+ DESCRIPTION
309
+ Login with your Factorial Code credentials (browser OAuth or email/password)
310
+
311
+ EXAMPLES
312
+ $ fcode login
313
+
314
+ $ fcode login --prompt
315
+
316
+ $ fcode login -e you@example.com -p your-password
317
+ ```
318
+
319
+ ## `fcode logout`
320
+
321
+ Logout from Factorial Code
322
+
323
+ ```
324
+ USAGE
325
+ $ fcode logout [-u <value>]
326
+
327
+ FLAGS
328
+ -u, --url=<value> [default: https://code.factorial.dev/platform] Factorial Code Cloud endpoint
329
+
330
+ DESCRIPTION
331
+ Logout from Factorial Code
332
+
333
+ EXAMPLES
334
+ $ fcode logout
335
+ ```
336
+
337
+ ## `fcode modules:add [RESOURCESLUG]`
338
+
339
+ Keeps track of a new local module
340
+
341
+ ```
342
+ USAGE
343
+ $ fcode modules:add [RESOURCESLUG]
344
+
345
+ ARGUMENTS
346
+ [RESOURCESLUG] Resource slug
347
+
348
+ DESCRIPTION
349
+ Keeps track of a new local module
350
+
351
+ EXAMPLES
352
+ $ fcode modules:add
353
+ ```
354
+
355
+ ## `fcode modules:pull [RESOURCESLUG]`
356
+
357
+ Fetch all modules from cloud and save them locally
358
+
359
+ ```
360
+ USAGE
361
+ $ fcode modules:pull [RESOURCESLUG] [-f]
362
+
363
+ ARGUMENTS
364
+ [RESOURCESLUG] Resource slug
365
+
366
+ FLAGS
367
+ -f, --force Force command
368
+
369
+ DESCRIPTION
370
+ Fetch all modules from cloud and save them locally
371
+
372
+ EXAMPLES
373
+ $ fcode modules:pull
374
+ ```
375
+
376
+ ## `fcode modules:push [RESOURCESLUG]`
377
+
378
+ Update cloud modules with local ones
379
+
380
+ ```
381
+ USAGE
382
+ $ fcode modules:push [RESOURCESLUG] [-f]
383
+
384
+ ARGUMENTS
385
+ [RESOURCESLUG] Resource slug
386
+
387
+ FLAGS
388
+ -f, --force Force command
389
+
390
+ DESCRIPTION
391
+ Update cloud modules with local ones
392
+
393
+ EXAMPLES
394
+ $ fcode modules:push
395
+ ```
396
+
397
+ ## `fcode modules:remove [RESOURCESLUG]`
398
+
399
+ Remove track of local modules
400
+
401
+ ```
402
+ USAGE
403
+ $ fcode modules:remove [RESOURCESLUG]
404
+
405
+ ARGUMENTS
406
+ [RESOURCESLUG] Resource slug
407
+
408
+ DESCRIPTION
409
+ Remove track of local modules
410
+
411
+ EXAMPLES
412
+ $ fcode modules:remove module-slug
413
+ ```
414
+
415
+ ## `fcode modules:reset [RESOURCESLUG]`
416
+
417
+ Reset modules with contents from current remote
418
+
419
+ ```
420
+ USAGE
421
+ $ fcode modules:reset [RESOURCESLUG]
422
+
423
+ ARGUMENTS
424
+ [RESOURCESLUG] Resource slug
425
+
426
+ DESCRIPTION
427
+ Reset modules with contents from current remote
428
+
429
+ EXAMPLES
430
+ $ fcode modules:reset
431
+ ```
432
+
433
+ ## `fcode modules:status [RESOURCESLUG]`
434
+
435
+ List all modules status
436
+
437
+ ```
438
+ USAGE
439
+ $ fcode modules:status [RESOURCESLUG]
440
+
441
+ ARGUMENTS
442
+ [RESOURCESLUG] Resource slug
443
+
444
+ DESCRIPTION
445
+ List all modules status
446
+
447
+ EXAMPLES
448
+ $ fcode modules:status
449
+ ```
450
+
451
+ ## `fcode processes:add [RESOURCESLUG]`
452
+
453
+ Keeps track of a new local process
454
+
455
+ ```
456
+ USAGE
457
+ $ fcode processes:add [RESOURCESLUG]
458
+
459
+ ARGUMENTS
460
+ [RESOURCESLUG] Resource slug
461
+
462
+ DESCRIPTION
463
+ Keeps track of a new local process
464
+
465
+ EXAMPLES
466
+ $ fcode processes:add
467
+ ```
468
+
469
+ ## `fcode processes:install-dependencies [RESOURCESLUG]`
470
+
471
+ Install Factorial Code process dependencies
472
+
473
+ ```
474
+ USAGE
475
+ $ fcode processes:install-dependencies [RESOURCESLUG] [-c] [-r] [-f]
476
+
477
+ ARGUMENTS
478
+ [RESOURCESLUG] Resource slug
479
+
480
+ FLAGS
481
+ -c, --check Check if is needed to install dependencies
482
+ -f, --force Force dependencies installation even if they are already installed
483
+ -r, --reset Remove all existing dependencies before installing
484
+
485
+ DESCRIPTION
486
+ Install Factorial Code process dependencies
487
+
488
+ EXAMPLES
489
+ $ fcode processes:install-dependencies [processSlug]
490
+ ```
491
+
492
+ ## `fcode processes:pull [RESOURCESLUG]`
493
+
494
+ Fetch all processes from cloud and save them locally
495
+
496
+ ```
497
+ USAGE
498
+ $ fcode processes:pull [RESOURCESLUG] [-f]
499
+
500
+ ARGUMENTS
501
+ [RESOURCESLUG] Resource slug
502
+
503
+ FLAGS
504
+ -f, --force Force command
505
+
506
+ DESCRIPTION
507
+ Fetch all processes from cloud and save them locally
508
+
509
+ EXAMPLES
510
+ $ fcode processes:pull
511
+ ```
512
+
513
+ ## `fcode processes:push [RESOURCESLUG]`
514
+
515
+ Update cloud processes with local ones
516
+
517
+ ```
518
+ USAGE
519
+ $ fcode processes:push [RESOURCESLUG] [-f]
520
+
521
+ ARGUMENTS
522
+ [RESOURCESLUG] Resource slug
523
+
524
+ FLAGS
525
+ -f, --force Force command
526
+
527
+ DESCRIPTION
528
+ Update cloud processes with local ones
529
+
530
+ EXAMPLES
531
+ $ fcode processes:push
532
+ ```
533
+
534
+ ## `fcode processes:remove [RESOURCESLUG]`
535
+
536
+ Remove track of local processes
537
+
538
+ ```
539
+ USAGE
540
+ $ fcode processes:remove [RESOURCESLUG]
541
+
542
+ ARGUMENTS
543
+ [RESOURCESLUG] Resource slug
544
+
545
+ DESCRIPTION
546
+ Remove track of local processes
547
+
548
+ EXAMPLES
549
+ $ fcode process:remove process-slug
550
+ ```
551
+
552
+ ## `fcode processes:reset [RESOURCESLUG]`
553
+
554
+ Reset processes with contents from current remote
555
+
556
+ ```
557
+ USAGE
558
+ $ fcode processes:reset [RESOURCESLUG]
559
+
560
+ ARGUMENTS
561
+ [RESOURCESLUG] Resource slug
562
+
563
+ DESCRIPTION
564
+ Reset processes with contents from current remote
565
+
566
+ EXAMPLES
567
+ $ fcode processes:reset
568
+ ```
569
+
570
+ ## `fcode processes:status [RESOURCESLUG]`
571
+
572
+ List all processes status
573
+
574
+ ```
575
+ USAGE
576
+ $ fcode processes:status [RESOURCESLUG]
577
+
578
+ ARGUMENTS
579
+ [RESOURCESLUG] Resource slug
580
+
581
+ DESCRIPTION
582
+ List all processes status
583
+
584
+ EXAMPLES
585
+ $ fcode processes:status
586
+ ```
587
+
588
+ ## `fcode pull`
589
+
590
+ Fetch from cloud team workspace and update local workspace
591
+
592
+ ```
593
+ USAGE
594
+ $ fcode pull [-f]
595
+
596
+ FLAGS
597
+ -f, --force Force command
598
+
599
+ DESCRIPTION
600
+ Fetch from cloud team workspace and update local workspace
601
+
602
+ EXAMPLES
603
+ $ fcode pull
604
+ ```
605
+
606
+ ## `fcode push`
607
+
608
+ Update cloud team workspace with local workspace
609
+
610
+ ```
611
+ USAGE
612
+ $ fcode push [-f]
613
+
614
+ FLAGS
615
+ -f, --force Force command
616
+
617
+ DESCRIPTION
618
+ Update cloud team workspace with local workspace
619
+
620
+ EXAMPLES
621
+ $ fcode push
622
+ ```
623
+
624
+ ## `fcode remote:add [TEAM]`
625
+
626
+ Add a remote team workspace
627
+
628
+ ```
629
+ USAGE
630
+ $ fcode remote:add [TEAM]
631
+
632
+ ARGUMENTS
633
+ [TEAM] Team name
634
+
635
+ DESCRIPTION
636
+ Add a remote team workspace
637
+
638
+ EXAMPLES
639
+ $ fcode remote:add
640
+ ```
641
+
642
+ ## `fcode remote:list`
643
+
644
+ List remote team workspaces
645
+
646
+ ```
647
+ USAGE
648
+ $ fcode remote:list
649
+
650
+ DESCRIPTION
651
+ List remote team workspaces
652
+
653
+ EXAMPLES
654
+ $ fcode remote:list
655
+ ```
656
+
657
+ ## `fcode remote:set [TEAM]`
658
+
659
+ Set the active remote team workspace
660
+
661
+ ```
662
+ USAGE
663
+ $ fcode remote:set [TEAM]
664
+
665
+ ARGUMENTS
666
+ [TEAM] Team name
667
+
668
+ DESCRIPTION
669
+ Set the active remote team workspace
670
+
671
+ EXAMPLES
672
+ $ fcode remote:set [team]
673
+ ```
674
+
675
+ ## `fcode reset`
676
+
677
+ Reset team workspace with contents from current remote
678
+
679
+ ```
680
+ USAGE
681
+ $ fcode reset
682
+
683
+ DESCRIPTION
684
+ Reset team workspace with contents from current remote
685
+
686
+ EXAMPLES
687
+ $ fcode reset
688
+ ```
689
+
690
+ ## `fcode run SLUG`
691
+
692
+ Run Factorial Code processes locally
693
+
694
+ ```
695
+ USAGE
696
+ $ fcode run SLUG [-p <value>] [-v <value>] [-l DEBUG|INFO|WARNING|ERROR] [-j] [-e <value>]
697
+
698
+ ARGUMENTS
699
+ SLUG Process slug
700
+
701
+ FLAGS
702
+ -e, --variablesFile=<value> Path to a .env file whose variables override workspace variables
703
+ -j, --jsonLogs Output process logs as newline-delimited JSON (NDJSON)
704
+ -l, --logLevel=<option> [default: DEBUG] Log level to use in process execution
705
+ <options: DEBUG|INFO|WARNING|ERROR>
706
+ -p, --parameters=<value> Parameters: stringified JSON or file path
707
+ -v, --version=<value> Process version
708
+
709
+ DESCRIPTION
710
+ Run Factorial Code processes locally
711
+
712
+ EXAMPLES
713
+ $ fcode run [process-slug]
714
+
715
+ $ fcode run --parameters ./parameters.json [process-slug]
716
+ ```
717
+
718
+ ## `fcode settings:get [KEY]`
719
+
720
+ Get a setting value or all settings
721
+
722
+ ```
723
+ USAGE
724
+ $ fcode settings:get [KEY] [-a]
725
+
726
+ ARGUMENTS
727
+ [KEY] Setting key (optional, shows all settings if omitted)
728
+
729
+ FLAGS
730
+ -a, --all Show all settings including defaults
731
+
732
+ DESCRIPTION
733
+ Get a setting value or all settings
734
+
735
+ EXAMPLES
736
+ $ fcode settings:get disableUpdateNotifier
737
+
738
+ $ fcode settings:get
739
+
740
+ $ fcode settings:get --all
741
+ ```
742
+
743
+ ## `fcode settings:remove KEY`
744
+
745
+ Remove a setting value
746
+
747
+ ```
748
+ USAGE
749
+ $ fcode settings:remove KEY
750
+
751
+ ARGUMENTS
752
+ KEY Setting key
753
+
754
+ DESCRIPTION
755
+ Remove a setting value
756
+
757
+ EXAMPLES
758
+ $ fcode settings:remove disableUpdateNotifier
759
+ ```
760
+
761
+ ## `fcode settings:set KEY VALUE`
762
+
763
+ Set a setting value
764
+
765
+ ```
766
+ USAGE
767
+ $ fcode settings:set KEY VALUE
768
+
769
+ ARGUMENTS
770
+ KEY Setting key
771
+ VALUE Setting value
772
+
773
+ DESCRIPTION
774
+ Set a setting value
775
+
776
+ EXAMPLES
777
+ $ fcode settings:set disableUpdateNotifier true
778
+
779
+ $ fcode settings:set ignoreWorkspaceNotEmpty false
780
+ ```
781
+
782
+ ## `fcode setup-debug`
783
+
784
+ Setup vscode debug configurations
785
+
786
+ ```
787
+ USAGE
788
+ $ fcode setup-debug
789
+
790
+ DESCRIPTION
791
+ Setup vscode debug configurations
792
+
793
+ EXAMPLES
794
+ $ fcode setup-debug
795
+ ```
796
+
797
+ ## `fcode status`
798
+
799
+ Show team workspace status
800
+
801
+ ```
802
+ USAGE
803
+ $ fcode status
804
+
805
+ DESCRIPTION
806
+ Show team workspace status
807
+
808
+ EXAMPLES
809
+ $ fcode status
810
+ ```
811
+
812
+ ## `fcode team:pull`
813
+
814
+ Fetch team settings (timezone, error handler, inheritance) from cloud into team.json
815
+
816
+ ```
817
+ USAGE
818
+ $ fcode team:pull
819
+
820
+ DESCRIPTION
821
+ Fetch team settings (timezone, error handler, inheritance) from cloud into team.json
822
+
823
+ EXAMPLES
824
+ $ fcode team:pull
825
+ ```
826
+
827
+ ## `fcode team:push`
828
+
829
+ Update cloud team settings (timezone, error handler, inheritance) from team.json
830
+
831
+ ```
832
+ USAGE
833
+ $ fcode team:push [-f]
834
+
835
+ FLAGS
836
+ -f, --force Force command
837
+
838
+ DESCRIPTION
839
+ Update cloud team settings (timezone, error handler, inheritance) from team.json
840
+
841
+ EXAMPLES
842
+ $ fcode team:push
843
+ ```
844
+
845
+ ## `fcode team:status`
846
+
847
+ Show whether team settings (timezone, error handler, inheritance) differ from the cloud
848
+
849
+ ```
850
+ USAGE
851
+ $ fcode team:status
852
+
853
+ DESCRIPTION
854
+ Show whether team settings (timezone, error handler, inheritance) differ from the cloud
855
+
856
+ EXAMPLES
857
+ $ fcode team:status
858
+ ```
859
+
860
+ ## `fcode test [SLUG]`
861
+
862
+ Run tests for Factorial Code processes
863
+
864
+ ```
865
+ USAGE
866
+ $ fcode test [SLUG] [-l DEBUG|INFO|WARNING|ERROR] [-j]
867
+
868
+ ARGUMENTS
869
+ [SLUG] Process slug (omit to test all processes)
870
+
871
+ FLAGS
872
+ -j, --jsonLogs Output process logs as newline-delimited JSON (NDJSON)
873
+ -l, --logLevel=<option> [default: ERROR] Log level for process execution during tests
874
+ <options: DEBUG|INFO|WARNING|ERROR>
875
+
876
+ DESCRIPTION
877
+ Run tests for Factorial Code processes
878
+
879
+ EXAMPLES
880
+ $ fcode test
881
+
882
+ $ fcode test [process-slug]
883
+
884
+ $ fcode test --logLevel DEBUG [process-slug]
885
+ ```
886
+
887
+ ## `fcode test:scaffold SLUG`
888
+
889
+ Create a starter test structure for a process
890
+
891
+ ```
892
+ USAGE
893
+ $ fcode test:scaffold SLUG
894
+
895
+ ARGUMENTS
896
+ SLUG Process slug to scaffold tests for
897
+
898
+ DESCRIPTION
899
+ Create a starter test structure for a process
900
+
901
+ EXAMPLES
902
+ $ fcode test:scaffold my-process
903
+ ```
904
+
905
+ ## `fcode variables:add [RESOURCESLUG]`
906
+
907
+ Keeps track of a new local variables
908
+
909
+ ```
910
+ USAGE
911
+ $ fcode variables:add [RESOURCESLUG] [-s]
912
+
913
+ ARGUMENTS
914
+ [RESOURCESLUG] Resource slug
915
+
916
+ FLAGS
917
+ -s, --sensitive Add variable as sensitive
918
+
919
+ DESCRIPTION
920
+ Keeps track of a new local variables
921
+
922
+ EXAMPLES
923
+ $ fcode variables:add
924
+ ```
925
+
926
+ ## `fcode variables:pull [RESOURCESLUG]`
927
+
928
+ Fetch all variables from cloud and save them locally
929
+
930
+ ```
931
+ USAGE
932
+ $ fcode variables:pull [RESOURCESLUG] [-f]
933
+
934
+ ARGUMENTS
935
+ [RESOURCESLUG] Resource slug
936
+
937
+ FLAGS
938
+ -f, --force Force command
939
+
940
+ DESCRIPTION
941
+ Fetch all variables from cloud and save them locally
942
+
943
+ EXAMPLES
944
+ $ fcode variables:pull
945
+ ```
946
+
947
+ ## `fcode variables:push [RESOURCESLUG]`
948
+
949
+ Create cloud variables from local ones
950
+
951
+ ```
952
+ USAGE
953
+ $ fcode variables:push [RESOURCESLUG] [-f]
954
+
955
+ ARGUMENTS
956
+ [RESOURCESLUG] Resource slug
957
+
958
+ FLAGS
959
+ -f, --force Force command
960
+
961
+ DESCRIPTION
962
+ Create cloud variables from local ones
963
+
964
+ EXAMPLES
965
+ $ fcode variables:push
966
+ ```
967
+
968
+ ## `fcode variables:remove [RESOURCESLUG]`
969
+
970
+ Remove track of local variables
971
+
972
+ ```
973
+ USAGE
974
+ $ fcode variables:remove [RESOURCESLUG]
975
+
976
+ ARGUMENTS
977
+ [RESOURCESLUG] Resource slug
978
+
979
+ DESCRIPTION
980
+ Remove track of local variables
981
+
982
+ EXAMPLES
983
+ $ fcode variables:remove variable-slug
984
+ ```
985
+
986
+ ## `fcode variables:reset [RESOURCESLUG]`
987
+
988
+ Reset variables with contents from current remote
989
+
990
+ ```
991
+ USAGE
992
+ $ fcode variables:reset [RESOURCESLUG]
993
+
994
+ ARGUMENTS
995
+ [RESOURCESLUG] Resource slug
996
+
997
+ DESCRIPTION
998
+ Reset variables with contents from current remote
999
+
1000
+ EXAMPLES
1001
+ $ fcode variables:reset
1002
+ ```
1003
+
1004
+ ## `fcode variables:status [RESOURCESLUG]`
1005
+
1006
+ List all variables status
1007
+
1008
+ ```
1009
+ USAGE
1010
+ $ fcode variables:status [RESOURCESLUG]
1011
+
1012
+ ARGUMENTS
1013
+ [RESOURCESLUG] Resource slug
1014
+
1015
+ DESCRIPTION
1016
+ List all variables status
1017
+
1018
+ EXAMPLES
1019
+ $ fcode variables:status
1020
+ ```
1021
+ <!-- commandsstop -->