@yepcode/cli v2.1.0
YepCode Command Line Interface
YepCode 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 YepCode Universe in the following links:
YepCode provides both a Graphic User Interface (GUI), accessible at https://cloud.yepcode.io, and a CLI for interacting with YepCode Cloud.
The YepCode Command Line Interface facilitates interaction with YepCode 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 YepCode Cloud.
See full documentation at https://yepcode.io/docs/cli/.
Usage
$ npm install -g @yepcode/cli
$ yepcode COMMAND
running command...
$ yepcode (--version)
@yepcode/cli/1.0.0 darwin-x64 node-v16.15.0
$ yepcode --help [COMMAND]
USAGE
$ yepcode COMMAND
...
Commands
yepcode help [COMMANDS]
yepcode login
yepcode logout
yepcode clone [TEAM]
yepcode status
yepcode pull
yepcode push
yepcode processes [SLUG]
yepcode processes:pull [SLUG]
yepcode processes:push [SLUG]
yepcode processes:status [SLUG]
yepcode processes:add [SLUG]
yepcode credentials:pull [SLUG]
yepcode credentials:status [SLUG]
yepcode modules:pull [SLUG]
yepcode modules:push [SLUG]
yepcode modules:status [SLUG]
yepcode modules:add [SLUG]
yepcode variables:pull [SLUG]
yepcode variables:status [SLUG]
yepcode run slug
yepcode remote:add slug
yepcode remote:set slug
yepcode add
yepcode help [COMMANDS]
Display help for yepcode.
USAGE
$ yepcode help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for yepcode.
yepcode login
Login into YepCode
USAGE
$ yepcode login -u <username> -p <password>
FLAGS
-u, --username=<value> (required) YepCode username
-p, --password=<value> (required) YepCode password
DESCRIPTION
Login into YepCode
EXAMPLES
$ yepcode -u john@domain.com -p p4s5w0rD
👐 Hi, John!
yepcode logout
Logout from YepCode
USAGE
$ yepcode logout
DESCRIPTION
Logout from YepCode
EXAMPLES
$ yepcode logout
👋 Bye!
yepcode clone [TEAM]
Clone team workspace from cloud
USAGE
$ yepcode clone [TEAM]
ARGUMENTS
TEAM Team slug
DESCRIPTION
Clone team workspace from cloud
EXAMPLES
$ yepcode clone
$ yepcode clone [team]
yepcode status
Show team workspace status
USAGE
$ yepcode status
DESCRIPTION
Show team workspace status
EXAMPLES
$ yepcode status
yepcode pull
Fetch from cloud team workspace and update local workspace
USAGE
$ yepcode pull [-f]
FLAGS
-f, --force Force pull
DESCRIPTION
Fetch from cloud team workspace and update local workspace
EXAMPLES
$ yepcode pull
yepcode push
Update cloud team workspace with local workspace
USAGE
$ yepcode push [-f]
FLAGS
-f, --force Force push
DESCRIPTION
Update cloud team workspace with local workspace
EXAMPLES
$ yepcode push
yepcode processes [SLUG]
List all processes
USAGE
$ yepcode processes [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
List all processes
EXAMPLES
$ yepcode processes:status
yepcode processes:pull [SLUG]
Fetch all processes from cloud and save them locally
USAGE
$ yepcode processes:pull [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all processes from cloud and save them locally
EXAMPLES
$ yepcode processes:pull
yepcode processes:push [SLUG]
Update cloud processes with local ones
USAGE
$ yepcode processes:push [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Update cloud processes with local ones
EXAMPLES
$ yepcode processes:push
yepcode processes:status [SLUG]
List all processes status
USAGE
$ yepcode processes:status [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
List all processes status
EXAMPLES
$ yepcode processes:status
yepcode processes:add [SLUG]
Keeps track of new local processes
USAGE
$ yepcode processes:add [SLUG]
ARGUMENTS
SLUG Resource slug
DESCRIPTION
Keeps track of new local processes
EXAMPLES
$ yepcode processes:add
yepcode credentials:pull [SLUG]
Fetch all credentials from cloud and save them locally
USAGE
$ yepcode credentials:pull [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all credentials from cloud and save them locally
EXAMPLES
$ yepcode credentials:pull
yepcode credentials:status [SLUG]
List all credentials status
USAGE
$ yepcode credentials:status [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
List all credentials status
EXAMPLES
$ yepcode credentials:status
yepcode modules:pull [SLUG]
Fetch all modules from cloud and save them locally
USAGE
$ yepcode modules:pull [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all modules from cloud and save them locally
EXAMPLES
$ yepcode modules:pull
yepcode modules:push [SLUG]
Update cloud modules with local ones
USAGE
$ yepcode modules:push [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Update cloud modules with local ones
EXAMPLES
$ yepcode modules:push
yepcode modules:status [SLUG]
List all modules status
USAGE
$ yepcode modules:status [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
List all modules status
EXAMPLES
$ yepcode modules:status
yepcode modules:add [SLUG]
Keeps track of new local modules
USAGE
$ yepcode modules:add [SLUG]
ARGUMENTS
SLUG Resource slug
DESCRIPTION
Keeps track of new local modules
EXAMPLES
$ yepcode modules:add
yepcode variables:pull [SLUG]
Fetch all variables from cloud and save them locally
USAGE
$ yepcode variables:pull [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
Fetch all variables from cloud and save them locally
EXAMPLES
$ yepcode variables:pull
yepcode variables:status [SLUG]
List all variables status
USAGE
$ yepcode variables:status [SLUG] [-f]
ARGUMENTS
SLUG Resource slug
FLAGS
-f, --force Force command
DESCRIPTION
List all variables status
EXAMPLES
$ yepcode variables:status
yepcode run slug
Run YepCode processes locally
USAGE
$ yepcode run slug [-p <value>]
ARGUMENTS
ID Process slug
FLAGS
-p, --parameters=<value> Parameters file path
DESCRIPTION
Run YepCode processes locally
EXAMPLES
$ yepcode run slug
$ yepcode run --parameters ./parameters.json slug
yepcode remote:add slug
Adds a remote workspace
USAGE
$ yepcode remote:add [TEAM]
ARGUMENTS
TEAM Team slug
DESCRIPTION
Adds a remote workspace
EXAMPLES
$ yepcode remote:add
$ yepcode remote:add [team]
yepcode remote:set slug
Set a remote workspace as active
USAGE
$ yepcode remote:set [TEAM]
ARGUMENTS
TEAM Team slug
DESCRIPTION
Sets a remote workspace as active
EXAMPLES
$ yepcode remote:set
$ yepcode remote:set [team]
yepcode add
Keeps track of new local components
USAGE
$ yepcode add
DESCRIPTION
Keeps track of new local components
EXAMPLES
$ yepcode add