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 Webpage
• YepCode Docs

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/4.0.1 linux-x64 node-v20.12.2
$ yepcode --help [COMMAND]
USAGE
  $ yepcode COMMAND
...

Commands

• yepcode add
• yepcode clone [TEAM]
• yepcode credentials:add [RESOURCESLUG]
• yepcode credentials:pull [RESOURCESLUG]
• yepcode credentials:push [RESOURCESLUG]
• yepcode credentials:remove [RESOURCESLUG]
• yepcode credentials:reset [RESOURCESLUG]
• yepcode credentials:status [RESOURCESLUG]
• yepcode dependencies:install [PROGRAMMINGLANGUAGE]
• yepcode dependencies:pull [RESOURCESLUG]
• yepcode dependencies:push [RESOURCESLUG]
• yepcode dependencies:reset [RESOURCESLUG]
• yepcode dependencies:status [RESOURCESLUG]
• yepcode help [COMMAND]
• yepcode login
• yepcode logout
• yepcode modules:add [RESOURCESLUG]
• yepcode modules:pull [RESOURCESLUG]
• yepcode modules:push [RESOURCESLUG]
• yepcode modules:remove [RESOURCESLUG]
• yepcode modules:reset [RESOURCESLUG]
• yepcode modules:status [RESOURCESLUG]
• yepcode plugins
• yepcode plugins:add PLUGIN
• yepcode plugins:inspect PLUGIN...
• yepcode plugins:install PLUGIN
• yepcode plugins:link PATH
• yepcode plugins:remove [PLUGIN]
• yepcode plugins:reset
• yepcode plugins:uninstall [PLUGIN]
• yepcode plugins:unlink [PLUGIN]
• yepcode plugins:update
• yepcode processes:add [RESOURCESLUG]
• yepcode processes:pull [RESOURCESLUG]
• yepcode processes:push [RESOURCESLUG]
• yepcode processes:remove [RESOURCESLUG]
• yepcode processes:reset [RESOURCESLUG]
• yepcode processes:status [RESOURCESLUG]
• yepcode pull
• yepcode push
• yepcode remote:add [TEAM]
• yepcode remote:set [TEAM]
• yepcode reset
• yepcode run SLUG
• yepcode status
• yepcode variables:add [RESOURCESLUG]
• yepcode variables:pull [RESOURCESLUG]
• yepcode variables:push [RESOURCESLUG]
• yepcode variables:remove [RESOURCESLUG]
• yepcode variables:reset [RESOURCESLUG]
• yepcode variables:status [RESOURCESLUG]

yepcode add

Keeps track of new local components

USAGE
  $ yepcode add

DESCRIPTION
  Keeps track of new local components

EXAMPLES
  $ yepcode add

yepcode clone [TEAM]

Clone team workspace from cloud

USAGE
  $ yepcode clone [TEAM]

ARGUMENTS
  TEAM  Team name

DESCRIPTION
  Clone team workspace from cloud

EXAMPLES
  $ yepcode clone

  $ yepcode clone [team]

yepcode credentials:add [RESOURCESLUG]

Keeps track of a new local credentials

USAGE
  $ yepcode credentials:add [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Keeps track of a new local credentials

EXAMPLES
  $ yepcode credentials:add

yepcode credentials:pull [RESOURCESLUG]

Fetch all credentials from cloud and save them locally

USAGE
  $ yepcode credentials:pull [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Fetch all credentials from cloud and save them locally

EXAMPLES
  $ yepcode credentials:pull

yepcode credentials:push [RESOURCESLUG]

Create cloud credentials from local ones

USAGE
  $ yepcode credentials:push [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Create cloud credentials from local ones

EXAMPLES
  $ yepcode credentials:push

yepcode credentials:remove [RESOURCESLUG]

Remove track of local credentials

USAGE
  $ yepcode credentials:remove [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Remove track of local credentials

EXAMPLES
  $ yepcode credentials:remove credential-slug

yepcode credentials:reset [RESOURCESLUG]

Reset credentials with contents from current remote

USAGE
  $ yepcode credentials:reset [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Reset credentials with contents from current remote

EXAMPLES
  $ yepcode credentials:reset

yepcode credentials:status [RESOURCESLUG]

List all credentials status

USAGE
  $ yepcode credentials:status [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  List all credentials status

EXAMPLES
  $ yepcode credentials:status

yepcode dependencies:install [PROGRAMMINGLANGUAGE]

Install YepCode dependencies

USAGE
  $ yepcode dependencies:install [PROGRAMMINGLANGUAGE] [-c] [-r]

ARGUMENTS
  PROGRAMMINGLANGUAGE  (all|javascript|python) [default: all] Programming language

FLAGS
  -c, --check  Check if is needed to install dependencies
  -r, --reset  Remove all existing dependencies before installing

DESCRIPTION
  Install YepCode dependencies

EXAMPLES
  $ yepcode dependencies:install [programmingLanguage]

yepcode dependencies:pull [RESOURCESLUG]

Fetch all dependencies from cloud and save them locally

USAGE
  $ yepcode dependencies:pull [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Fetch all dependencies from cloud and save them locally

EXAMPLES
  $ yepcode dependencies:pull

yepcode dependencies:push [RESOURCESLUG]

Update cloud dependencies with local ones

USAGE
  $ yepcode dependencies:push [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Update cloud dependencies with local ones

EXAMPLES
  $ yepcode dependencies:push

yepcode dependencies:reset [RESOURCESLUG]

Reset dependencies with contents from current remote

USAGE
  $ yepcode dependencies:reset [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Reset dependencies with contents from current remote

EXAMPLES
  $ yepcode dependencies:reset

yepcode dependencies:status [RESOURCESLUG]

List all dependencies status

USAGE
  $ yepcode dependencies:status [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  List all dependencies status

EXAMPLES
  $ yepcode dependencies:status

yepcode help [COMMAND]

Display help for yepcode.

USAGE
  $ yepcode 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 yepcode.

See code: @oclif/plugin-help

yepcode login

Login with your YepCode credentials

USAGE
  $ yepcode login [-u <value>] [-a <value>] [-e <value>] [-p <value>] [-c <value>] [-s <value>]

FLAGS
  -a, --authUrl=<value>       YepCode Auth endpoint (including realm, ie:
                              https://cloud.yepcode.io/auth/realms/yepcode)). 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)
  -u, --url=<value>           [default: https://cloud.yepcode.io] YepCode Cloud endpoint

DESCRIPTION
  Login with your YepCode credentials

EXAMPLES
  $ yepcode login

yepcode logout

Logout from YepCode

USAGE
  $ yepcode logout [-u <value>]

FLAGS
  -u, --url=<value>  [default: https://cloud.yepcode.io] YepCode Cloud endpoint

DESCRIPTION
  Logout from YepCode

EXAMPLES
  $ yepcode logout

yepcode modules:add [RESOURCESLUG]

Keeps track of a new local module

USAGE
  $ yepcode modules:add [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Keeps track of a new local module

EXAMPLES
  $ yepcode modules:add

yepcode modules:pull [RESOURCESLUG]

Fetch all modules from cloud and save them locally

USAGE
  $ yepcode modules:pull [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Fetch all modules from cloud and save them locally

EXAMPLES
  $ yepcode modules:pull

yepcode modules:push [RESOURCESLUG]

Update cloud modules with local ones

USAGE
  $ yepcode modules:push [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Update cloud modules with local ones

EXAMPLES
  $ yepcode modules:push

yepcode modules:remove [RESOURCESLUG]

Remove track of local modules

USAGE
  $ yepcode modules:remove [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Remove track of local modules

EXAMPLES
  $ yepcode modules:remove module-slug

yepcode modules:reset [RESOURCESLUG]

Reset modules with contents from current remote

USAGE
  $ yepcode modules:reset [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Reset modules with contents from current remote

EXAMPLES
  $ yepcode modules:reset

yepcode modules:status [RESOURCESLUG]

List all modules status

USAGE
  $ yepcode modules:status [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  List all modules status

EXAMPLES
  $ yepcode modules:status

yepcode plugins

List installed plugins.

USAGE
  $ yepcode plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ yepcode plugins

See code: @oclif/plugin-plugins

yepcode plugins:add PLUGIN

Installs a plugin into yepcode.

USAGE
  $ yepcode plugins:add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into yepcode.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the YEPCODE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the YEPCODE_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ yepcode plugins:add

EXAMPLES
  Install a plugin from npm registry.

    $ yepcode plugins:add myplugin

  Install a plugin from a github url.

    $ yepcode plugins:add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ yepcode plugins:add someuser/someplugin

yepcode plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ yepcode plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ yepcode plugins:inspect myplugin

See code: @oclif/plugin-plugins

yepcode plugins:install PLUGIN

Installs a plugin into yepcode.

USAGE
  $ yepcode plugins:install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into yepcode.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the YEPCODE_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the YEPCODE_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ yepcode plugins:add

EXAMPLES
  Install a plugin from npm registry.

    $ yepcode plugins:install myplugin

  Install a plugin from a github url.

    $ yepcode plugins:install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ yepcode plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

yepcode plugins:link PATH

Links a plugin into the CLI for development.

USAGE
  $ yepcode plugins:link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ yepcode plugins:link myplugin

See code: @oclif/plugin-plugins

yepcode plugins:remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ yepcode plugins:remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ yepcode plugins:unlink
  $ yepcode plugins:remove

EXAMPLES
  $ yepcode plugins:remove myplugin

yepcode plugins:reset

Remove all user-installed and linked plugins.

USAGE
  $ yepcode plugins:reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

yepcode plugins:uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ yepcode plugins:uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ yepcode plugins:unlink
  $ yepcode plugins:remove

EXAMPLES
  $ yepcode plugins:uninstall myplugin

See code: @oclif/plugin-plugins

yepcode plugins:unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ yepcode plugins:unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ yepcode plugins:unlink
  $ yepcode plugins:remove

EXAMPLES
  $ yepcode plugins:unlink myplugin

yepcode plugins:update

Update installed plugins.

USAGE
  $ yepcode plugins:update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

yepcode processes:add [RESOURCESLUG]

Keeps track of a new local process

USAGE
  $ yepcode processes:add [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Keeps track of a new local process

EXAMPLES
  $ yepcode processes:add

yepcode processes:pull [RESOURCESLUG]

Fetch all processes from cloud and save them locally

USAGE
  $ yepcode processes:pull [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Fetch all processes from cloud and save them locally

EXAMPLES
  $ yepcode processes:pull

yepcode processes:push [RESOURCESLUG]

Update cloud processes with local ones

USAGE
  $ yepcode processes:push [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Update cloud processes with local ones

EXAMPLES
  $ yepcode processes:push

yepcode processes:remove [RESOURCESLUG]

Remove track of local processes

USAGE
  $ yepcode processes:remove [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Remove track of local processes

EXAMPLES
  $ yepcode process:remove process-slug

yepcode processes:reset [RESOURCESLUG]

Reset processes with contents from current remote

USAGE
  $ yepcode processes:reset [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Reset processes with contents from current remote

EXAMPLES
  $ yepcode processes:reset

yepcode processes:status [RESOURCESLUG]

List all processes status

USAGE
  $ yepcode processes:status [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  List all processes status

EXAMPLES
  $ yepcode processes:status

yepcode pull

Fetch from cloud team workspace and update local workspace

USAGE
  $ yepcode pull [-f]

FLAGS
  -f, --force  Force command

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 command

DESCRIPTION
  Update cloud team workspace with local workspace

EXAMPLES
  $ yepcode push

yepcode remote:add [TEAM]

Add a remote team workspace

USAGE
  $ yepcode remote:add [TEAM]

ARGUMENTS
  TEAM  Team name

DESCRIPTION
  Add a remote team workspace

EXAMPLES
  $ yepcode remote:add

yepcode remote:set [TEAM]

Set the active remote team workspace

USAGE
  $ yepcode remote:set [TEAM]

ARGUMENTS
  TEAM  Team name

DESCRIPTION
  Set the active remote team workspace

EXAMPLES
  $ yepcode remote:set [team]

yepcode reset

Reset team workspace with contents from current remote

USAGE
  $ yepcode reset

DESCRIPTION
  Reset team workspace with contents from current remote

EXAMPLES
  $ yepcode reset

yepcode run SLUG

Run YepCode processes locally

USAGE
  $ yepcode run SLUG [-p <value>] [-v <value>] [-l DEBUG|INFO|WARNING|ERROR]

ARGUMENTS
  SLUG  Process slug

FLAGS
  -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

DESCRIPTION
  Run YepCode processes locally

EXAMPLES
  $ yepcode run [process-slug]

  $ yepcode run --parameters ./parameters.json [process-slug]

yepcode status

Show team workspace status

USAGE
  $ yepcode status

DESCRIPTION
  Show team workspace status

EXAMPLES
  $ yepcode status

yepcode variables:add [RESOURCESLUG]

Keeps track of a new local variables

USAGE
  $ yepcode variables:add [RESOURCESLUG] [-s]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -s, --sensitive  Add variable as sensitive

DESCRIPTION
  Keeps track of a new local variables

EXAMPLES
  $ yepcode variables:add

yepcode variables:pull [RESOURCESLUG]

Fetch all variables from cloud and save them locally

USAGE
  $ yepcode variables:pull [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Fetch all variables from cloud and save them locally

EXAMPLES
  $ yepcode variables:pull

yepcode variables:push [RESOURCESLUG]

Create cloud variables from local ones

USAGE
  $ yepcode variables:push [RESOURCESLUG] [-f]

ARGUMENTS
  RESOURCESLUG  Resource slug

FLAGS
  -f, --force  Force command

DESCRIPTION
  Create cloud variables from local ones

EXAMPLES
  $ yepcode variables:push

yepcode variables:remove [RESOURCESLUG]

Remove track of local variables

USAGE
  $ yepcode variables:remove [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Remove track of local variables

EXAMPLES
  $ yepcode variables:remove variable-slug

yepcode variables:reset [RESOURCESLUG]

Reset variables with contents from current remote

USAGE
  $ yepcode variables:reset [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  Reset variables with contents from current remote

EXAMPLES
  $ yepcode variables:reset

yepcode variables:status [RESOURCESLUG]

List all variables status

USAGE
  $ yepcode variables:status [RESOURCESLUG]

ARGUMENTS
  RESOURCESLUG  Resource slug

DESCRIPTION
  List all variables status

EXAMPLES
  $ yepcode variables:status