YepCode Command Line Interface Rules

Comprehensive guidelines for AI agents to use YepCode CLI for local development, testing, and synchronization with YepCode Cloud.

Download this file

What is YepCode CLI?

The YepCode CLI facilitates interaction with YepCode Cloud directly from your local workstation’s command line. It’s particularly useful for developing and testing processes locally.

Command Flow

Always follow this sequence:

Make changes to local files (processes, modules, variables, etc.)
Run yepcode add to add new local resources to the context of YepCode CLI (prepare resources for execution or deployment)
Run yepcode run to test (execute the process locally for development/testing purposes)
Run yepcode push to deploy to cloud (when ready for production synchronization)

Core CLI Commands

`yepcode add`

Purpose: Add new local resources (processes, modules, variables, etc.) to the context of YepCode CLI to prepare them for execution or deployment. It may be the solution if you get the error “Local process not found.”

Usage:

yepcode add

When to use:

Before running yepcode run to test
Before running yepcode push to deploy

What it does:

Updates the local workspace state
Makes processes ready for execution or deployment

Important: This command is required before yepcode run or yepcode push

`yepcode run <process-slug> --parameters <filepath | stringified-json>`

Purpose: Execute a process locally for development/testing

Usage:

# Using a parameters file
yepcode run <process-slug> --parameters <filepath>

# Using stringified JSON
yepcode run <process-slug> --parameters '{"key": "value"}'

# Using default parameters.json from process folder
yepcode run <process-slug>

When to use:

To test process execution locally
To debug issues with detailed logs
During iterative development to validate changes

What it does:

Executes the process code locally
Uses environment variables from variables.env and variables.local.env
Uses provided parameters or default parameters.json
Shows execution logs
Shows execution results and errors (if any)

Prerequisites:

Must run yepcode add first if the process was just created

`yepcode push`

Purpose: Deploy local changes to YepCode cloud

Usage:

yepcode push

When to use:

When the process is ready for production
After testing locally with yepcode run
To make changes available in the cloud

What it does:

Uploads local files to YepCode cloud
Updates cloud resources with local changes
Makes the process available for cloud execution

Prerequisites:

Must run yepcode add first to prepare changes
Recommended to run yepcode run first to test

Complete Workflow Examples

Example 1: Development Cycle

Agent: “I’ve implemented the script. Would you like to test it locally?”

User: “Yes”

Agent: “I’ll sync and run it for you.”

[Agent runs yepcode add] [Agent runs yepcode run]

Agent: “The logs look good! Would you like to push to production?”

User: “Yes”

Agent: “Deploying to production now.”

[Agent runs yepcode push (no need to run yepcode add again since nothing changed)]

Example 2: Testing a New Process

User: “I need to test the new shopify-order-sync process locally with some parameters”

AI: “I’ll add the process first and then run it for you.”

yepcode add

yepcode run shopify-order-sync --parameters '{"dateFrom": "2024-01-01", "dateTo": "2024-01-31"}'

Example 3: Deploying to Production

User: “The inventory-sync process is ready for production. Please deploy it to the cloud.”

AI: “I’ll sync the process and push it to production.”

yepcode add

yepcode push

Critical Rules

NEVER run yepcode run without running yepcode add first
NEVER run yepcode push without running yepcode add first