lcaresia/pd-scripts

Scripts for developing Pipedream components

pd-scripts

Scripts for developing Pipedream components

• Dependencies
• Installation
• Usage
• Commands

Dependencies

• Node.js
• Google Chrome
• Pipedream CLI

Installation

npm

Requires Node.js 8+

Install the package globally by running the following command:

npm install -g @js07/pd-scripts

macOS Installer

Download and open pd-scripts.pkg.

Windows Executable

• Windows (32-bit): pd-scripts-x86.exe
• Windows (64-bit): pd-scripts-x64.exe

Binaries

Extract the tar archive file and place the pd-scripts folder somewhere in your PATH.

• Linux (x64)
• Linux (ARM)
• Windows (32-bit)
• Windows (64-bit)
• macOS (64-bit)

Usage

$ npm install -g @js07/pd-scripts
$ pd-scripts COMMAND
running command...
$ pd-scripts (-v|--version|version)
@js07/pd-scripts/0.2.1 darwin-x64 node-v14.18.1
$ pd-scripts --help [COMMAND]
USAGE
  $ pd-scripts COMMAND
...

Commands

• pd-scripts create FILES
• pd-scripts help [COMMAND]
• pd-scripts publish FILES
• pd-scripts qa FILES
• pd-scripts refresh URL
• pd-scripts update [CHANNEL]
• pd-scripts version:bump FILES
• pd-scripts version:dev FILES
• pd-scripts version:reset FILES
• pd-scripts version:restore FILES
• pd-scripts version:set FILES
• pd-scripts version:show
• pd-scripts version:store FILES

pd-scripts create FILES

Create a workflow from action files

USAGE
  $ pd-scripts create FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help               show CLI help
  -p, --password=password  (required) Pipedream password
  -u, --username=username  (required) Pipedream username or email
  --app=app                (required) App name
  --[no-]combined          Add all actions to the same workflow
  --[no-]headless          run puppeteer in headless mode
  --selectAccount          select connected app account in action config

See code: src/commands/create.ts

pd-scripts help [COMMAND]

display help for pd-scripts

USAGE
  $ pd-scripts help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

pd-scripts publish FILES

Publish actions

USAGE
  $ pd-scripts publish FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help         show CLI help
  --dev              use dev mode
  --profile=profile  pipedream profile to use

See code: src/commands/publish.ts

pd-scripts qa FILES

Publish and create a workflow from actions

USAGE
  $ pd-scripts qa FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help               show CLI help
  -p, --password=password  (required) Pipedream password
  -u, --username=username  (required) Pipedream username or email
  --app=app                (required) App name
  --[no-]combined          Add all actions to the same workflow
  --dev                    use dev mode
  --[no-]headless          run puppeteer in headless mode
  --profile=profile        pipedream profile to use
  --selectAccount          select connected app account in action config

EXAMPLE
  $ pd-scripts qa components/confection --app "Confection" -u <PDUsernawme> -p "<PDPassword>"

See code: src/commands/qa.ts

pd-scripts refresh URL

Refresh actions in a workflow

USAGE
  $ pd-scripts refresh URL

ARGUMENTS
  URL  url of workflow

OPTIONS
  -h, --help               show CLI help
  -p, --password=password  (required) Pipedream password
  -u, --username=username  (required) Pipedream username or email
  --[no-]headless          run puppeteer in headless mode

EXAMPLE
  $ pd-scripts refresh https://pipedream.com/@pdusername/workflow-name-p_OKCKmHN/edit -u "<PDUsernawme>" -p 
  "<PDPassword>"

See code: src/commands/refresh.ts

pd-scripts update [CHANNEL]

update the pd-scripts CLI

USAGE
  $ pd-scripts update [CHANNEL]

OPTIONS
  --from-local  interactively choose an already installed version

See code: @oclif/plugin-update

pd-scripts version:bump FILES

Bump action versions

USAGE
  $ pd-scripts version:bump FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help   show CLI help
  --storePrev  store action versions to restore later?

See code: src/commands/version/bump.ts

pd-scripts version:dev FILES

Set action versions to current timestamp

USAGE
  $ pd-scripts version:dev FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help   show CLI help
  --storePrev  store action versions to restore later?

See code: src/commands/version/dev.ts

pd-scripts version:reset FILES

Reset action versions to 0.0.1

USAGE
  $ pd-scripts version:reset FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help   show CLI help
  --storePrev  store action versions to restore later?

See code: src/commands/version/reset.ts

pd-scripts version:restore FILES

Restore action versions to previously stored versions

USAGE
  $ pd-scripts version:restore FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help  show CLI help

See code: src/commands/version/restore.ts

pd-scripts version:set FILES

Set action versions

USAGE
  $ pd-scripts version:set FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help             show CLI help
  -v, --version=version  (required)
  --storePrev            store action versions to restore later?

See code: src/commands/version/set.ts

pd-scripts version:show

Show stored versions

USAGE
  $ pd-scripts version:show

OPTIONS
  -h, --help  show CLI help

See code: src/commands/version/show.ts

pd-scripts version:store FILES

Store action versions

USAGE
  $ pd-scripts version:store FILES

ARGUMENTS
  FILES  action files or folder

OPTIONS
  -h, --help  show CLI help

See code: src/commands/version/store.ts