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.
pd describe
, you can use either of the following commands:
pd delete
pd list so
to display a list of your event sources.
pd deploy
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 the source’s key
(defined in the component file for the source):
pd describe
pd dev
pd dev
allows you to interactively develop a source from a local file.pd dev
will link your local file with the deployed component and watch your local file for changes. When you save changes to your local file, your component will automatically be updated on Pipedream.
pd dev
and want to link the same deployed source to your local file, you can pass the deployed component ID using the --dc
flag:
pd events
pd events
prints (up to) the last 10 events sent to your source.
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
connects to the SSE stream tied to your source and displays events as the source produces them.
-n
and -f
options to list historical events and follow the source for new events.
pd help
pd help events
, pd help describe
, etc.
pd init
pd init app
pd init action
pd init source
Prop type | Flag |
---|---|
Database | --db |
HTTP | --http |
Timer | --timer |
pd list
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:
sources
and streams
have shorter aliases, too:
pd login
pd logout
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 logs
pd logs
displays logs for a source.
Running 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.
pd publish
pd publish
command.
pd signup
pd unpublish
key
:
pd update
api_key
field:
<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:
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.
org_id
to your profile.
--profile <profile_name>
when running any command. For example, if you named your profile workspace
, you’d run this command to publish a component:
pd
command by setting the -p
or --profile
flag. For example, to list the sources in a specific account, run:
pd
CLI, run
pd
config file contains your Pipedream API keys (tied to your default account, or other profiles) and other configuration used by the CLI.
If the XDG_CONFIG_HOME
env var is set, the config file will be found in $XDG_CONFIG_HOME/pipedream
.
Otherwise, it will be found in $HOME/.config/pipedream
.
PD_CLI_DO_NOT_TRACK
environment variable to true
or 1
.