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

``sh-session
$ npm install -g @yepcode/cli
$ yepcode COMMAND
running command...
$ yepcode (--version)
@yepcode/cli/5.3.5 linux-x64 node-v20.12.2
$ yepcode --help [COMMAND]
USAGE
$ yepcode COMMAND
...
`

Commands

* yepcode add
* yepcode ai-rules:pull
* [yepcode clone [TEAM]](#yepcode-clone-team)
* [yepcode dependencies:add [RESOURCESLUG]](#yepcode-dependenciesadd-resourceslug)
* [yepcode dependencies:install [PROGRAMMINGLANGUAGE]](#yepcode-dependenciesinstall-programminglanguage)
* [yepcode dependencies:pull [RESOURCESLUG]](#yepcode-dependenciespull-resourceslug)
* [yepcode dependencies:push [RESOURCESLUG]](#yepcode-dependenciespush-resourceslug)
* [yepcode dependencies:reset [RESOURCESLUG]](#yepcode-dependenciesreset-resourceslug)
* [yepcode dependencies:status [RESOURCESLUG]](#yepcode-dependenciesstatus-resourceslug)
* [yepcode help [COMMAND]](#yepcode-help-command)
* yepcode login
* yepcode logout
* yepcode mcp:configure
* [yepcode modules:add [RESOURCESLUG]](#yepcode-modulesadd-resourceslug)
* [yepcode modules:pull [RESOURCESLUG]](#yepcode-modulespull-resourceslug)
* [yepcode modules:push [RESOURCESLUG]](#yepcode-modulespush-resourceslug)
* [yepcode modules:remove [RESOURCESLUG]](#yepcode-modulesremove-resourceslug)
* [yepcode modules:reset [RESOURCESLUG]](#yepcode-modulesreset-resourceslug)
* [yepcode modules:status [RESOURCESLUG]](#yepcode-modulesstatus-resourceslug)
* [yepcode processes:add [RESOURCESLUG]](#yepcode-processesadd-resourceslug)
* [yepcode processes:install-dependencies [RESOURCESLUG]](#yepcode-processesinstall-dependencies-resourceslug)
* [yepcode processes:pull [RESOURCESLUG]](#yepcode-processespull-resourceslug)
* [yepcode processes:push [RESOURCESLUG]](#yepcode-processespush-resourceslug)
* [yepcode processes:remove [RESOURCESLUG]](#yepcode-processesremove-resourceslug)
* [yepcode processes:reset [RESOURCESLUG]](#yepcode-processesreset-resourceslug)
* [yepcode processes:status [RESOURCESLUG]](#yepcode-processesstatus-resourceslug)
* yepcode pull
* yepcode push
* [yepcode remote:add [TEAM]](#yepcode-remoteadd-team)
* [yepcode remote:set [TEAM]](#yepcode-remoteset-team)
* yepcode reset
* yepcode run SLUG
* [yepcode settings:get [KEY]](#yepcode-settingsget-key)
* yepcode settings:remove KEY
* yepcode settings:set KEY VALUE
* yepcode setup-debug
* yepcode status
* [yepcode variables:add [RESOURCESLUG]](#yepcode-variablesadd-resourceslug)
* [yepcode variables:pull [RESOURCESLUG]](#yepcode-variablespull-resourceslug)
* [yepcode variables:push [RESOURCESLUG]](#yepcode-variablespush-resourceslug)
* [yepcode variables:remove [RESOURCESLUG]](#yepcode-variablesremove-resourceslug)
* [yepcode variables:reset [RESOURCESLUG]](#yepcode-variablesreset-resourceslug)
* [yepcode variables:status [RESOURCESLUG]](#yepcode-variablesstatus-resourceslug)

yepcode add

Keeps track of new local components

`
USAGE
$ yepcode add

DESCRIPTION
Keeps track of new local components

EXAMPLES
$ yepcode add
`

yepcode ai-rules:pull

Download and setup YepCode coding rules for AI assistants

`
USAGE
$ yepcode ai-rules:pull [-a ...]

FLAGS
-a, --assistants=... AI assistants to configure rules for

DESCRIPTION
Download and setup YepCode coding rules for AI assistants

EXAMPLES
$ yepcode ai-rules:pull

$ yepcode ai-rules:pull -a cursor

$ yepcode ai-rules:pull -a cursor -a claude
`

yepcode clone [TEAM]

Clone team workspace from cloud

`
USAGE
$ yepcode clone [TEAM] [--skipAiAssistantSetup]

ARGUMENTS
[TEAM] Team name

FLAGS
--skipAiAssistantSetup Skip setup of AI rules and MCP server

DESCRIPTION
Clone team workspace from cloud

EXAMPLES
$ yepcode clone

$ yepcode clone [team]
`

yepcode dependencies:add [RESOURCESLUG]

Keeps track of dependencies

`
USAGE
$ yepcode dependencies:add [RESOURCESLUG]

ARGUMENTS
[RESOURCESLUG] Resource slug

DESCRIPTION
Keeps track of dependencies

EXAMPLES
$ yepcode dependencies:add
`

yepcode dependencies:install [PROGRAMMINGLANGUAGE]

Install YepCode dependencies

`
USAGE
$ yepcode 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 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 ] [-a ] [-e ] [-p ] [-c ] [-s ] [-t ]

FLAGS
-a, --authUrl= 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= Client ID (for oauth, to be used with Client Secret)
-e, --email= Email (to be used with password)
-p, --password= Password (to be used with email)
-s, --clientSecret= Client Secret (for oauth, to be used with Client ID)
-t, --accessToken= Access Token (to be used instead of email and password)
-u, --url= [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 ]

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

DESCRIPTION
Logout from YepCode

EXAMPLES
$ yepcode logout
`

yepcode mcp:configure

Configure YepCode MCP server for AI assistants

`
USAGE
$ yepcode mcp:configure [-a ...]

FLAGS
-a, --assistants=... AI assistants to configure MCP server for

DESCRIPTION
Configure YepCode MCP server for AI assistants

EXAMPLES
$ yepcode mcp:configure

$ yepcode mcp:configure -a cursor

$ yepcode mcp:configure -a cursor -a claude
`

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 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:install-dependencies [RESOURCESLUG]

Install YepCode process dependencies

`
USAGE
$ yepcode 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 YepCode process dependencies

EXAMPLES
$ yepcode processes:install-dependencies [processSlug]
`

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 ] [-v ] [-l DEBUG|INFO|WARNING|ERROR]

ARGUMENTS
SLUG Process slug

FLAGS
-l, --logLevel= [default: DEBUG] Log level to use in process execution

-p, --parameters= Parameters: stringified JSON or file path
-v, --version= Process version

DESCRIPTION
Run YepCode processes locally

EXAMPLES
$ yepcode run [process-slug]

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

yepcode settings:get [KEY]

Get a setting value or all settings

`
USAGE
$ yepcode settings:get [KEY] [-a]

ARGUMENTS
[KEY] Setting key (optional, shows all settings if omitted)

FLAGS
-a, --all Show all settings including defaults

DESCRIPTION
Get a setting value or all settings

EXAMPLES
$ yepcode settings:get disableUpdateNotifier

$ yepcode settings:get

$ yepcode settings:get --all
`

yepcode settings:remove KEY

Remove a setting value

`
USAGE
$ yepcode settings:remove KEY

ARGUMENTS
KEY Setting key

DESCRIPTION
Remove a setting value

EXAMPLES
$ yepcode settings:remove disableUpdateNotifier
`

yepcode settings:set KEY VALUE

Set a setting value

`
USAGE
$ yepcode settings:set KEY VALUE

ARGUMENTS
KEY Setting key
VALUE Setting value

DESCRIPTION
Set a setting value

EXAMPLES
$ yepcode settings:set disableUpdateNotifier true

$ yepcode settings:set ignoreWorkspaceNotEmpty false
`

yepcode setup-debug

Setup vscode debug configurations

`
USAGE
$ yepcode setup-debug

DESCRIPTION
Setup vscode debug configurations

EXAMPLES
$ yepcode setup-debug
`

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