# CLI Reference
Since this is a preview release, the commands you see below, and the REST API, are subject to change based on feedback.
# Installing the CLI
See the CLI installation docs to learn how to install the CLI for your OS / architecture.
# Command Reference
pd to see a list of all commands with basic usage info, or run
pd help <command> to display help docs for a specific command.
We've also documented each command below, with usage examples for each.
# General Notes
Everywhere you can refer to a specific source as an argument, you can use the source's ID or its name slug. For example, to retrieve details about a specific source using
pd describe, you can use either of the following commands:
λ ~/ pd describe dc_abc123 id: dc_abc123 name: http endpoint: https://myendpoint.m.pipedream.net λ ~/ pd describe http Searching for sources matching http id: dc_abc123 name: http endpoint: https://myendpoint.m.pipedream.net
Deletes an event source. Run:
pd describe <source-id-or-name>
pd list so to display a list of your event sources.
Deploy an event source from local or remote code.
pd deploy, without any arguments, brings up an interactive menu asking you select a source. This list of sources is retrieved from the registry of public sources published to Github.
When you select a source, we'll deploy it and start listening for new events.
You can also deploy a specific source via Github URL:
pd deploy https://github.com/PipedreamHQ/pipedream/blob/master/components/http/http.js
or author a component locally and deploy that local file:
pd deploy http.js
Display the details for a source: its id, name, and other configuration details:
pd describe <source-id-or-name>
Returns historical events sent to a source, and streams emitted events directly to the CLI.
pd events <source-id-or-name>
pd events prints (up to) the last 10 events sent to your source.
pd events -n 100 <source-id-or-name>
pd events -n N retrieves the last
N events sent to your source. We store the last 100 events sent to a source, so you can retrieve a max of 100 events using this command.
pd events -f <source-id-or-name>
pd events -f connects to the SSE stream tied to your source and displays events as the source produces them.
pd events -n N -f <source-id-or-name>
You can combine the
-f options to list historical events and follow the source for new events.
Displays help for any command. Run
pd help events,
pd help describe, etc.
Lists Pipedream resources you own. Running
pd list without any arguments prompts you to select the type of resource you'd like to list.
You can also list specific resource types directly:
pd list sources
pd list streams
streams have shorter aliases, too:
pd list so
pd list st
Log in to Pipedream CLI and persist API key locally. See Logging into the CLI for more information.
Unsets the local API key tied to your account.
pd logout without any arguments removes the default API key from your config file.
You can remove the API key for a specific profile by running:
pd logout -p <profile>
Event sources produce logs that can be useful for troubleshooting issues with that source.
pd logs displays logs for a source.
pd logs <source-id-or-name> connects to the SSE logs stream tied to your source, displaying new logs as the source produces them.
Any errors thrown by the source will also appear here.
Sign up for Pipedream via the CLI and persist your API key locally. See the docs on Signing up for Pipedream via the CLI for more information.
Updates the code, props, or metadata for an event source.
If you deployed a source from Github, for example, someone might publish an update to that source, and you may want to run the updated code.
pd update <source-id-or-name> --code https://github.com/PipedreamHQ/pipedream/blob/master/components/http/http.js
You can change the name of a source:
pd update <source-id-or-name> --name new-awesome-name
You can deactivate a source if you want to stop it from running:
pd update <source-id-or-name> --deactivate
or activate a source you previously deactivated:
pd update <source-id-or-name> --activate
Profiles allow you to work with multiple, named Pipedream accounts via the CLI.
# Creating a new profile
When you login to the CLI, the CLI writes the API key for that account to your config file, in the
api_key = abc123
You can set API keys for other, named profiles, too. Run
pd login -p <profile>
<profile> can be any string of shell-safe characters that you'd like to use to identify this new profile. The CLI opens up a browser asking you to login to your target Pipedream account, then writes the API key to a section of the config file under this profile:
[your_profile] api_key = def456
You can also run
pd signup -p <profile> if you'd like to sign up for a new Pipedream account via the CLI and set a named profile for that account.
# Using profiles
You can set a profile on any
pd command by setting the
--profile flag. For example, to list the sources in a specific account, run:
pd list sources --profile <profile>
To get the current version of the
pd CLI, run
The CLI is configured to check for new versions automatically. This ensures you're always running the most up-to-date version.
# CLI config file
pd config file contains your Pipedream API keys (tied to your default account, or other profiles) and other configuration used by the CLI.
XDG_CONFIG_HOME env var is set, the config file will be found in
Otherwise, it will be found in
If you'd like to opt-out of CLI analytics, set the
PD_CLI_DO_NOT_TRACK environment variable to