UCD.js Docs
CLI

pipelines

Run and manage UCD data processing pipelines

ucd pipelines

Run and manage UCD data processing pipelines. Pipelines can be loaded from local files or directly from remote GitHub/GitLab repositories.

ucd pipelines <subcommand> [...flags]

run

Run one or more pipelines.

ucd pipelines run [...pipelines] [...flags]

Provide pipeline selectors as positional arguments to run specific pipelines. Omit them to run all discovered pipelines.

Flags

FlagDescription
--cwdDirectory to search for pipeline files (default: current directory)
--github <owner/repo>Load pipelines from a GitHub repository
--gitlab <owner/repo>Load pipelines from a GitLab repository
--refGit ref (branch, tag, or SHA) for remote sources
--pathSubdirectory path within the repository
--uiLaunch the pipeline UI alongside the run
--portPort for the UI server (default: 3030)

Examples

# Run all local pipelines
ucd pipelines run

# Run a specific pipeline
ucd pipelines run my-pipeline

# Run pipelines from a GitHub repository
ucd pipelines run --github ucdjs/pipelines --ref main

# Run with the UI
ucd pipelines run --ui --port 4000

list

List all available pipelines.

ucd pipelines list [...flags]

Flags

FlagDescription
--cwdDirectory to search for pipeline files (default: current directory)
--github <owner/repo>Load pipelines from a GitHub repository
--gitlab <owner/repo>Load pipelines from a GitLab repository
--refGit ref (branch, tag, or SHA) for remote sources
--pathSubdirectory path within the repository or local directory

Examples

ucd pipelines list
ucd pipelines list --github ucdjs/pipelines --ref main

cache

Manage the local cache of remote pipeline sources.

ucd pipelines cache <subcommand> [...flags]

cache status

Show cache status for remote pipeline sources.

ucd pipelines cache status [...flags]
FlagDescription
--github <owner/repo>Show cache status for a GitHub repository
--gitlab <owner/repo>Show cache status for a GitLab repository
--refGit ref (branch, tag, or SHA)

cache clear

Remove cached remote pipeline sources.

ucd pipelines cache clear [...flags]
FlagDescription
--github <owner/repo>Clear cache for a GitHub repository
--gitlab <owner/repo>Clear cache for a GitLab repository
--refGit ref (default: HEAD)
--allClear all cached sources

cache refresh

Sync a remote pipeline source into the local cache.

ucd pipelines cache refresh [...flags]
FlagDescription
--github <owner/repo>Sync a GitHub repository to the local cache
--gitlab <owner/repo>Sync a GitLab repository to the local cache
--refGit ref (default: HEAD)
--forceRe-download even if already up to date

Examples

# Check cache status
ucd pipelines cache status --github ucdjs/pipelines

# Clear all cached sources
ucd pipelines cache clear --all

# Refresh a specific repo
ucd pipelines cache refresh --github ucdjs/pipelines --ref main

On this page