@factorialco/fcode-cli
v3.1.0
Published
Factorial Code Command Line Interface
Readme
Factorial Code Command Line Interface
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:
Factorial Code provides both a Graphic User Interface (GUI), accessible at https://code.factorialhr.com, and a CLI for interacting with Factorial Code Cloud.
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.
See full documentation at https://code.factorialhr.com/docs/cli/.
For a guide on writing and running tests for your processes, see TEST.md.
Usage
$ npm install -g @factorialco/fcode-cli
$ fcode COMMAND
running command...
$ fcode (--version)
@factorialco/fcode-cli/3.1.0 linux-x64 node-v22.22.3
$ fcode --help [COMMAND]
USAGE
$ fcode COMMAND
...Commands
fcode addfcode clone [TEAM]fcode config:get [KEY]fcode config:remove KEYfcode config:set KEY VALUEfcode dependencies:add [RESOURCESLUG]fcode dependencies:diff [RESOURCESLUG]fcode dependencies:install [PROGRAMMINGLANGUAGE]fcode dependencies:pull [RESOURCESLUG]fcode dependencies:push [RESOURCESLUG]fcode dependencies:reset [RESOURCESLUG]fcode dependencies:status [RESOURCESLUG]fcode difffcode help [COMMAND]fcode httpfcode i18n:add [RESOURCESLUG]fcode i18n:diff [RESOURCESLUG]fcode i18n:pull [RESOURCESLUG]fcode i18n:push [RESOURCESLUG]fcode i18n:remove [RESOURCESLUG]fcode i18n:reset [RESOURCESLUG]fcode i18n:status [RESOURCESLUG]fcode loginfcode logoutfcode modules:add [RESOURCESLUG]fcode modules:diff [RESOURCESLUG]fcode modules:pull [RESOURCESLUG]fcode modules:push [RESOURCESLUG]fcode modules:remove [RESOURCESLUG]fcode modules:reset [RESOURCESLUG]fcode modules:status [RESOURCESLUG]fcode processes:add [RESOURCESLUG]fcode processes:diff [RESOURCESLUG]fcode processes:install-dependencies [RESOURCESLUG]fcode processes:pull [RESOURCESLUG]fcode processes:push [RESOURCESLUG]fcode processes:remove [RESOURCESLUG]fcode processes:reset [RESOURCESLUG]fcode processes:status [RESOURCESLUG]fcode pullfcode pushfcode remote:add [TEAM]fcode remote:listfcode remote:set [TEAM]fcode resetfcode run SLUGfcode settings:aliases:delete NAMEfcode settings:aliases:listfcode settings:aliases:set NAME TAGfcode settings:difffcode settings:pullfcode settings:pushfcode settings:statusfcode settings:versions:create TAGfcode settings:versions:delete TAGfcode settings:versions:listfcode setup-debugfcode statusfcode team:clone [TEAMID]fcode team:pullfcode team:statusfcode test [SLUG]fcode test:scaffold SLUGfcode variables:add [RESOURCESLUG]fcode variables:diff [RESOURCESLUG]fcode variables:pull [RESOURCESLUG]fcode variables:push [RESOURCESLUG]fcode variables:remove [RESOURCESLUG]fcode variables:reset [RESOURCESLUG]fcode variables:status [RESOURCESLUG]
fcode add
Keeps track of new local components
USAGE
$ fcode add
DESCRIPTION
Keeps track of new local components
EXAMPLES
$ fcode addfcode clone [TEAM]
Clone team workspace from cloud
USAGE
$ fcode clone [TEAM] [--skipSkillsSetup]
ARGUMENTS
[TEAM] Team name
FLAGS
--skipSkillsSetup Skip installation of the Factorial Code agent skills
DESCRIPTION
Clone team workspace from cloud
EXAMPLES
$ fcode clone
$ fcode clone [team]fcode config:get [KEY]
Get a CLI setting value or all CLI settings
USAGE
$ fcode config:get [KEY] [-a]
ARGUMENTS
[KEY] Setting key (optional, shows all settings if omitted)
FLAGS
-a, --all Show all settings including defaults
DESCRIPTION
Get a CLI setting value or all CLI settings
EXAMPLES
$ fcode config:get disableUpdateNotifier
$ fcode config:get
$ fcode config:get --allfcode config:remove KEY
Remove a CLI setting value
USAGE
$ fcode config:remove KEY
ARGUMENTS
KEY Setting key
DESCRIPTION
Remove a CLI setting value
EXAMPLES
$ fcode config:remove disableUpdateNotifierfcode config:set KEY VALUE
Set a CLI setting value
USAGE
$ fcode config:set KEY VALUE
ARGUMENTS
KEY Setting key
VALUE Setting value
DESCRIPTION
Set a CLI setting value
EXAMPLES
$ fcode config:set disableUpdateNotifier true
$ fcode config:set ignoreWorkspaceNotEmpty falsefcode dependencies:add [RESOURCESLUG]
Keeps track of dependencies
USAGE
$ fcode dependencies:add [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Keeps track of dependencies
EXAMPLES
$ fcode dependencies:addfcode dependencies:diff [RESOURCESLUG]
Show a unified diff between local dependency manifests and the cloud. Exits 1 when they differ
USAGE
$ fcode dependencies:diff [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Show a unified diff between local dependency manifests and the cloud. Exits 1 when they differ
EXAMPLES
$ fcode dependencies:diff
$ fcode dependencies:diff JAVASCRIPTfcode dependencies:install [PROGRAMMINGLANGUAGE]
Install Factorial Code dependencies
USAGE
$ fcode dependencies:install [PROGRAMMINGLANGUAGE] [-c] [-r] [-f]
ARGUMENTS
[PROGRAMMINGLANGUAGE] (all|javascript|python) [default: all] Programming language
FLAGS
-c, --check Check if is needed to install dependencies
-f, --force Force dependencies installation even if they are already installed
-r, --reset Remove all existing dependencies before installing
DESCRIPTION
Install Factorial Code dependencies
EXAMPLES
$ fcode dependencies:install [programmingLanguage]fcode dependencies:pull [RESOURCESLUG]
Fetch all dependencies from cloud and save them locally
USAGE
$ fcode dependencies:pull [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all dependencies from cloud and save them locally
EXAMPLES
$ fcode dependencies:pullfcode dependencies:push [RESOURCESLUG]
Update cloud dependencies with local ones
USAGE
$ fcode dependencies:push [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Update cloud dependencies with local ones
EXAMPLES
$ fcode dependencies:pushfcode dependencies:reset [RESOURCESLUG]
Reset dependencies with contents from current remote
USAGE
$ fcode dependencies:reset [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Reset dependencies with contents from current remote
EXAMPLES
$ fcode dependencies:resetfcode dependencies:status [RESOURCESLUG]
List all dependencies status
USAGE
$ fcode dependencies:status [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
List all dependencies status
EXAMPLES
$ fcode dependencies:statusfcode diff
Show a unified diff between the local workspace and the cloud. Exits 1 when they differ
USAGE
$ fcode diff
DESCRIPTION
Show a unified diff between the local workspace and the cloud. Exits 1 when they differ
EXAMPLES
$ fcode difffcode help [COMMAND]
Display help for fcode.
USAGE
$ fcode help [COMMAND...] [-n]
ARGUMENTS
[COMMAND...] Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for fcode.See code: @oclif/plugin-help
fcode http
Start a local HTTP server to trigger Factorial Code processes via webhooks and expose forms schema
USAGE
$ fcode http [-P <value>] [-l DEBUG|INFO|WARNING|ERROR] [--auth-user <value>] [--auth-password <value>]
[-j]
FLAGS
-P, --port=<value> [default: 3000] Port to listen on
-j, --jsonLogs Output process logs as newline-delimited JSON (NDJSON)
-l, --logLevel=<option> [default: DEBUG] Log level to use in process executions
<options: DEBUG|INFO|WARNING|ERROR>
--auth-password=<value> Basic auth password
--auth-user=<value> Basic auth username
DESCRIPTION
Start a local HTTP server to trigger Factorial Code processes via webhooks and expose forms schema
EXAMPLES
$ fcode http
$ fcode http --port 8080
$ fcode http --auth-user admin --auth-password secretfcode i18n:add [RESOURCESLUG]
Keeps track of new local locales
USAGE
$ fcode i18n:add [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Keeps track of new local locales
EXAMPLES
$ fcode i18n:add
$ fcode i18n:add pt-BRfcode i18n:diff [RESOURCESLUG]
Show a unified diff between local locales and the cloud. Exits 1 when they differ
USAGE
$ fcode i18n:diff [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Show a unified diff between local locales and the cloud. Exits 1 when they differ
EXAMPLES
$ fcode i18n:diff
$ fcode i18n:diff enfcode i18n:pull [RESOURCESLUG]
Fetch all locales from cloud and save them locally
USAGE
$ fcode i18n:pull [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all locales from cloud and save them locally
EXAMPLES
$ fcode i18n:pullfcode i18n:push [RESOURCESLUG]
Create or update cloud locales from local ones
USAGE
$ fcode i18n:push [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Create or update cloud locales from local ones
EXAMPLES
$ fcode i18n:push
$ fcode i18n:push pt-BRfcode i18n:remove [RESOURCESLUG]
Remove track of a local locale
USAGE
$ fcode i18n:remove [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Remove track of a local locale
EXAMPLES
$ fcode i18n:remove pt-BRfcode i18n:reset [RESOURCESLUG]
Reset locales with contents from current remote
USAGE
$ fcode i18n:reset [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Reset locales with contents from current remote
EXAMPLES
$ fcode i18n:resetfcode i18n:status [RESOURCESLUG]
List all locales status
USAGE
$ fcode i18n:status [RESOURCESLUG] [--showInherited]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
--showInherited Also list inherited resources that have no changes
DESCRIPTION
List all locales status
EXAMPLES
$ fcode i18n:statusfcode login
Login with your Factorial Code credentials (browser OAuth or email/password)
USAGE
$ fcode login [-u <value>] [-a <value>] [-e <value>] [-p <value>] [-c <value>] [-s <value>] [-t <value>]
[-x]
FLAGS
-a, --authUrl=<value> Factorial Code Auth endpoint (including realm, ie:
https://code.factorialhr.com/auth/realms/fcode)). Only needed if auth domain is different
than used cloud endpoint
-c, --clientId=<value> Client ID (for oauth, to be used with Client Secret)
-e, --email=<value> Email (to be used with password)
-p, --password=<value> Password (to be used with email)
-s, --clientSecret=<value> Client Secret (for oauth, to be used with Client ID)
-t, --accessToken=<value> Access Token (to be used instead of email and password)
-u, --url=<value> [default: https://code.factorialhr.com/platform] Factorial Code Cloud endpoint (host or
full /platform URL, ie: code.factorialhr.com)
-x, --prompt Prompt for email and password (instead of opening browser)
DESCRIPTION
Login with your Factorial Code credentials (browser OAuth or email/password)
EXAMPLES
$ fcode login
$ fcode login --prompt
$ fcode login -e [email protected] -p your-passwordfcode logout
Logout from Factorial Code
USAGE
$ fcode logout [-u <value>]
FLAGS
-u, --url=<value> [default: https://code.factorialhr.com/platform] Factorial Code Cloud endpoint (host or full
/platform URL, ie: code.factorialhr.com)
DESCRIPTION
Logout from Factorial Code
EXAMPLES
$ fcode logoutfcode modules:add [RESOURCESLUG]
Keeps track of a new local module
USAGE
$ fcode modules:add [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Keeps track of a new local module
EXAMPLES
$ fcode modules:addfcode modules:diff [RESOURCESLUG]
Show a unified diff between local modules and the cloud. Exits 1 when they differ
USAGE
$ fcode modules:diff [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Show a unified diff between local modules and the cloud. Exits 1 when they differ
EXAMPLES
$ fcode modules:diff
$ fcode modules:diff my-modulefcode modules:pull [RESOURCESLUG]
Fetch all modules from cloud and save them locally
USAGE
$ fcode modules:pull [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all modules from cloud and save them locally
EXAMPLES
$ fcode modules:pullfcode modules:push [RESOURCESLUG]
Update cloud modules with local ones
USAGE
$ fcode modules:push [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Update cloud modules with local ones
EXAMPLES
$ fcode modules:pushfcode modules:remove [RESOURCESLUG]
Remove track of local modules
USAGE
$ fcode modules:remove [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Remove track of local modules
EXAMPLES
$ fcode modules:remove module-slugfcode modules:reset [RESOURCESLUG]
Reset modules with contents from current remote
USAGE
$ fcode modules:reset [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Reset modules with contents from current remote
EXAMPLES
$ fcode modules:resetfcode modules:status [RESOURCESLUG]
List all modules status
USAGE
$ fcode modules:status [RESOURCESLUG] [--showInherited]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
--showInherited Also list inherited resources that have no changes
DESCRIPTION
List all modules status
EXAMPLES
$ fcode modules:statusfcode processes:add [RESOURCESLUG]
Keeps track of a new local process
USAGE
$ fcode processes:add [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Keeps track of a new local process
EXAMPLES
$ fcode processes:addfcode processes:diff [RESOURCESLUG]
Show a unified diff between local processes and the cloud. Exits 1 when they differ
USAGE
$ fcode processes:diff [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Show a unified diff between local processes and the cloud. Exits 1 when they differ
EXAMPLES
$ fcode processes:diff
$ fcode processes:diff hello-worldfcode processes:install-dependencies [RESOURCESLUG]
Install Factorial Code process dependencies
USAGE
$ fcode processes:install-dependencies [RESOURCESLUG] [-c] [-r] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-c, --check Check if is needed to install dependencies
-f, --force Force dependencies installation even if they are already installed
-r, --reset Remove all existing dependencies before installing
DESCRIPTION
Install Factorial Code process dependencies
EXAMPLES
$ fcode processes:install-dependencies [processSlug]fcode processes:pull [RESOURCESLUG]
Fetch all processes from cloud and save them locally
USAGE
$ fcode processes:pull [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all processes from cloud and save them locally
EXAMPLES
$ fcode processes:pullfcode processes:push [RESOURCESLUG]
Update cloud processes with local ones
USAGE
$ fcode processes:push [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Update cloud processes with local ones
EXAMPLES
$ fcode processes:pushfcode processes:remove [RESOURCESLUG]
Remove track of local processes
USAGE
$ fcode processes:remove [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Remove track of local processes
EXAMPLES
$ fcode process:remove process-slugfcode processes:reset [RESOURCESLUG]
Reset processes with contents from current remote
USAGE
$ fcode processes:reset [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Reset processes with contents from current remote
EXAMPLES
$ fcode processes:resetfcode processes:status [RESOURCESLUG]
List all processes status
USAGE
$ fcode processes:status [RESOURCESLUG] [--showInherited]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
--showInherited Also list inherited resources that have no changes
DESCRIPTION
List all processes status
EXAMPLES
$ fcode processes:statusfcode pull
Fetch from cloud team workspace and update local workspace
USAGE
$ fcode pull [-f]
FLAGS
-f, --force Force command
DESCRIPTION
Fetch from cloud team workspace and update local workspace
EXAMPLES
$ fcode pullfcode push
Update cloud team workspace with local workspace
USAGE
$ fcode push [-f]
FLAGS
-f, --force Force command
DESCRIPTION
Update cloud team workspace with local workspace
EXAMPLES
$ fcode pushfcode remote:add [TEAM]
Add a remote team workspace
USAGE
$ fcode remote:add [TEAM]
ARGUMENTS
[TEAM] Team name
DESCRIPTION
Add a remote team workspace
EXAMPLES
$ fcode remote:addfcode remote:list
List remote team workspaces
USAGE
$ fcode remote:list
DESCRIPTION
List remote team workspaces
EXAMPLES
$ fcode remote:listfcode remote:set [TEAM]
Set the active remote team workspace
USAGE
$ fcode remote:set [TEAM]
ARGUMENTS
[TEAM] Team name
DESCRIPTION
Set the active remote team workspace
EXAMPLES
$ fcode remote:set [team]fcode reset
Reset team workspace with contents from current remote
USAGE
$ fcode reset
DESCRIPTION
Reset team workspace with contents from current remote
EXAMPLES
$ fcode resetfcode run SLUG
Run Factorial Code processes locally
USAGE
$ fcode run SLUG [-p <value>] [-v <value>] [-l DEBUG|INFO|WARNING|ERROR] [-j] [--locale <value>] [-e
<value>]
ARGUMENTS
SLUG Process slug
FLAGS
-e, --variablesFile=<value> Path to a .env file whose variables override workspace variables
-j, --jsonLogs Output process logs as newline-delimited JSON (NDJSON)
-l, --logLevel=<option> [default: DEBUG] Log level to use in process execution
<options: DEBUG|INFO|WARNING|ERROR>
-p, --parameters=<value> Parameters: stringified JSON or file path
-v, --version=<value> Process version
--locale=<value> Locale fcode.i18n resolves against (defaults to the workspace primaryLocale)
DESCRIPTION
Run Factorial Code processes locally
EXAMPLES
$ fcode run [process-slug]
$ fcode run --parameters ./parameters.json [process-slug]fcode settings:aliases:delete NAME
Delete a workspace version alias and the per-entity aliases carrying its name on every owned process and module
USAGE
$ fcode settings:aliases:delete NAME
ARGUMENTS
NAME alias name to delete
DESCRIPTION
Delete a workspace version alias and the per-entity aliases carrying its name on every owned process and module
EXAMPLES
$ fcode settings:aliases:delete productionfcode settings:aliases:list
List the workspace version aliases of the active workspace
USAGE
$ fcode settings:aliases:list
DESCRIPTION
List the workspace version aliases of the active workspace
EXAMPLES
$ fcode settings:aliases:listfcode settings:aliases:set NAME TAG
Create or re-point a workspace version alias, upserting the per-entity alias on every owned process and module that has the target tag published
USAGE
$ fcode settings:aliases:set NAME TAG
ARGUMENTS
NAME alias name (e.g. production)
TAG workspace version tag the alias points at
DESCRIPTION
Create or re-point a workspace version alias, upserting the per-entity alias on every owned process and module that
has the target tag published
EXAMPLES
$ fcode settings:aliases:set production v1.0.0fcode settings:diff
Show a unified diff between local workspace settings (settings.json) and the cloud. Exits 1 when they differ
USAGE
$ fcode settings:diff
DESCRIPTION
Show a unified diff between local workspace settings (settings.json) and the cloud. Exits 1 when they differ
EXAMPLES
$ fcode settings:difffcode settings:pull
Fetch workspace settings (timezone, error handler, inheritance) and workspace versions/aliases from cloud into settings.json
USAGE
$ fcode settings:pull [-f]
FLAGS
-f, --force Force command
DESCRIPTION
Fetch workspace settings (timezone, error handler, inheritance) and workspace versions/aliases from cloud into
settings.json
EXAMPLES
$ fcode settings:pullfcode settings:push
Update cloud workspace settings (timezone, error handler, inheritance, webhook auth) and sync workspace versions/aliases from settings.json
USAGE
$ fcode settings:push [-f]
FLAGS
-f, --force Force command
DESCRIPTION
Update cloud workspace settings (timezone, error handler, inheritance, webhook auth) and sync workspace
versions/aliases from settings.json
EXAMPLES
$ fcode settings:pushfcode settings:status
Show whether workspace settings (timezone, error handler, inheritance) or workspace versions/aliases differ from the cloud
USAGE
$ fcode settings:status
DESCRIPTION
Show whether workspace settings (timezone, error handler, inheritance) or workspace versions/aliases differ from the
cloud
EXAMPLES
$ fcode settings:statusfcode settings:versions:create TAG
Publish a workspace version: creates a version with the tag on every owned process and module (existing tags are skipped) and pins bare module imports in the published snapshots
USAGE
$ fcode settings:versions:create TAG [-c <value>]
ARGUMENTS
TAG version tag to publish (e.g. v1.0.0)
FLAGS
-c, --comment=<value> comment describing the version
DESCRIPTION
Publish a workspace version: creates a version with the tag on every owned process and module (existing tags are
skipped) and pins bare module imports in the published snapshots
EXAMPLES
$ fcode settings:versions:create v1.0.0
$ fcode settings:versions:create v1.0.0 --comment "First stable release"fcode settings:versions:delete TAG
Delete a workspace version. CASCADES: every owned process/module version with the tag is deleted, together with the aliases, executions and schedules that reference them
USAGE
$ fcode settings:versions:delete TAG [-f]
ARGUMENTS
TAG version tag to delete
FLAGS
-f, --force Force command
DESCRIPTION
Delete a workspace version. CASCADES: every owned process/module version with the tag is deleted, together with the
aliases, executions and schedules that reference them
EXAMPLES
$ fcode settings:versions:delete v1.0.0fcode settings:versions:list
List the workspace versions published on the active workspace
USAGE
$ fcode settings:versions:list
DESCRIPTION
List the workspace versions published on the active workspace
EXAMPLES
$ fcode settings:versions:listfcode setup-debug
Setup vscode debug configurations
USAGE
$ fcode setup-debug
DESCRIPTION
Setup vscode debug configurations
EXAMPLES
$ fcode setup-debugfcode status
Show team workspace status
USAGE
$ fcode status [--showInherited]
FLAGS
--showInherited Also list inherited resources that have no changes
DESCRIPTION
Show team workspace status
EXAMPLES
$ fcode status
$ fcode status --showInheritedfcode team:clone [TEAMID]
Clone a development team into one folder — an App folder each, holding the App's development workspace, plus the team's global workspaces under global-workspaces/
USAGE
$ fcode team:clone [TEAMID] [--skipSkillsSetup]
ARGUMENTS
[TEAMID] development team id (run without it to list the teams you belong to)
FLAGS
--skipSkillsSetup Skip installation of the Factorial Code agent skills
DESCRIPTION
Clone a development team into one folder — an App folder each, holding the App's development workspace, plus the
team's global workspaces under global-workspaces/
EXAMPLES
$ fcode team:clone
$ fcode team:clone 0f9c1a2b-3d4e-5f60-8a1b-2c3d4e5f6071fcode team:pull
Pull the development team folder: clones Apps and global workspaces added since the last run and pulls every workspace
USAGE
$ fcode team:pull
DESCRIPTION
Pull the development team folder: clones Apps and global workspaces added since the last run and pulls every workspace
EXAMPLES
$ fcode team:pullfcode team:status
Show what differs from the cloud in every workspace of the development team folder
USAGE
$ fcode team:status
DESCRIPTION
Show what differs from the cloud in every workspace of the development team folder
EXAMPLES
$ fcode team:statusfcode test [SLUG]
Run tests for Factorial Code processes
USAGE
$ fcode test [SLUG] [-l DEBUG|INFO|WARNING|ERROR] [-j]
ARGUMENTS
[SLUG] Process slug (omit to test all processes)
FLAGS
-j, --jsonLogs Output process logs as newline-delimited JSON (NDJSON)
-l, --logLevel=<option> [default: ERROR] Log level for process execution during tests
<options: DEBUG|INFO|WARNING|ERROR>
DESCRIPTION
Run tests for Factorial Code processes
EXAMPLES
$ fcode test
$ fcode test [process-slug]
$ fcode test --logLevel DEBUG [process-slug]fcode test:scaffold SLUG
Create a starter test structure for a process
USAGE
$ fcode test:scaffold SLUG
ARGUMENTS
SLUG Process slug to scaffold tests for
DESCRIPTION
Create a starter test structure for a process
EXAMPLES
$ fcode test:scaffold my-processfcode variables:add [RESOURCESLUG]
Keeps track of a new local variables
USAGE
$ fcode variables:add [RESOURCESLUG] [-s]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-s, --sensitive Add variable as sensitive
DESCRIPTION
Keeps track of a new local variables
EXAMPLES
$ fcode variables:addfcode variables:diff [RESOURCESLUG]
Show a unified diff between local variables and the cloud. Sensitive values are never printed. Exits 1 when they differ
USAGE
$ fcode variables:diff [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Show a unified diff between local variables and the cloud. Sensitive values are never printed. Exits 1 when they
differ
EXAMPLES
$ fcode variables:diff
$ fcode variables:diff MY_VARIABLEfcode variables:pull [RESOURCESLUG]
Fetch all variables from cloud and save them locally
USAGE
$ fcode variables:pull [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all variables from cloud and save them locally
EXAMPLES
$ fcode variables:pullfcode variables:push [RESOURCESLUG]
Create cloud variables from local ones
USAGE
$ fcode variables:push [RESOURCESLUG] [-f]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Create cloud variables from local ones
EXAMPLES
$ fcode variables:pushfcode variables:remove [RESOURCESLUG]
Remove track of local variables
USAGE
$ fcode variables:remove [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Remove track of local variables
EXAMPLES
$ fcode variables:remove variable-slugfcode variables:reset [RESOURCESLUG]
Reset variables with contents from current remote
USAGE
$ fcode variables:reset [RESOURCESLUG]
ARGUMENTS
[RESOURCESLUG] Resource slug
DESCRIPTION
Reset variables with contents from current remote
EXAMPLES
$ fcode variables:resetfcode variables:status [RESOURCESLUG]
List all variables status
USAGE
$ fcode variables:status [RESOURCESLUG] [--showInherited]
ARGUMENTS
[RESOURCESLUG] Resource slug
FLAGS
--showInherited Also list inherited resources that have no changes
DESCRIPTION
List all variables status
EXAMPLES
$ fcode variables:status