Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions docs-v2/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -438,17 +438,37 @@ export default withNextra({
},
{
source: "/cli/",
destination: "/workflows/cli/reference/",
destination: "/components/contributing/cli/reference/",
permanent: true,
},
{
source: "/cli/reference/",
destination: "/workflows/cli/reference/",
destination: "/components/contributing/cli/reference/",
permanent: true,
},
{
source: "/cli/login/",
destination: "/workflows/cli/login/",
destination: "/components/contributing/cli/login/",
permanent: true,
},
{
source: "/cli/install/",
destination: "/components/contributing/cli/install/",
permanent: true,
},
{
source: "/cli/:path*",
destination: "/components/contributing/cli/:path*",
permanent: true,
},
{
source: "/workflows/cli/",
destination: "/components/contributing/cli/reference/",
permanent: true,
},
{
source: "/workflows/cli/:path*",
destination: "/components/contributing/cli/:path*",
permanent: true,
},
{
Expand Down
1 change: 1 addition & 0 deletions docs-v2/pages/components/contributing/_meta.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ export default {
"sources-quickstart": "Quickstart — Sources",
"guidelines": "Guidelines",
"typescript": "TypeScript components",
"cli": "CLI",
} as const
6 changes: 3 additions & 3 deletions docs-v2/pages/components/contributing/actions-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ If you previously developed actions using Pipedream's UI, we recommend reviewing
## Prerequisites

- Create a free account at [https://pipedream.com](https://pipedream.com)
- Download and install the [Pipedream CLI](/workflows/cli/install/)
- Once the CLI is installed, [link your Pipedream account](/workflows/cli/login/#existing-pipedream-account) to the CLI by running `pd login` in your terminal
- Download and install the [Pipedream CLI](/components/contributing/cli/install/)
- Once the CLI is installed, [link your Pipedream account](/components/contributing/cli/login/#existing-pipedream-account) to the CLI by running `pd login` in your terminal

> **NOTE:** See the [CLI reference](/workflows/cli/reference/) for detailed usage and examples beyond those covered below.
> **NOTE:** See the [CLI reference](/components/contributing/cli/reference/) for detailed usage and examples beyond those covered below.

## Walkthrough

Expand Down
10 changes: 5 additions & 5 deletions docs-v2/pages/components/contributing/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Components are Node.js modules that run on Pipedream's serverless infrastructure

- Trigger Node.js code on HTTP requests, timers, cron schedules, or manually
- Emit data on each event to inspect it. Trigger Pipedream hosted workflows or access it outside of Pipedream via API
- Accept user input on deploy via [CLI](/workflows/cli/reference/#pd-deploy), [API](/workflows/rest-api), or [UI](https://pipedream.com/sources)
- Accept user input on deploy via [CLI](/components/contributing/cli/reference/#pd-deploy), [API](/workflows/rest-api), or [UI](https://pipedream.com/sources)
- Connect to [{process.env.PUBLIC_APPS}+ apps](https://pipedream.com/apps) using Pipedream managed auth
- Use most npm packages with no `npm install` or `package.json` required
- Store and retrieve state using the [built-in key-value store](#db)
Expand Down Expand Up @@ -49,9 +49,9 @@ Sources and actions share the same component API. However, certain features of t

### Getting Started with the CLI

Several examples below use the Pipedream CLI. To install it, [follow the instructions for your OS / architecture](/workflows/cli/install/).
Several examples below use the Pipedream CLI. To install it, [follow the instructions for your OS / architecture](/components/contributing/cli/install/).

See the [CLI reference](/workflows/cli/reference/) for detailed usage and examples beyond those covered below.
See the [CLI reference](/components/contributing/cli/reference/) for detailed usage and examples beyond those covered below.

### Example Components

Expand Down Expand Up @@ -1052,11 +1052,11 @@ pd deploy https://raw.githubusercontent.com/PipedreamHQ/pipedream/master/compone

#### CLI - Update

View the [CLI command reference](/workflows/cli/reference/#command-reference).
View the [CLI command reference](/components/contributing/cli/reference/#command-reference).

#### CLI - Delete

View the [CLI command reference](/workflows/cli/reference/#command-reference).
View the [CLI command reference](/components/contributing/cli/reference/#command-reference).

#### UI - Deploy

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ The `pd` binary is available via Nix flake [here](https://github.com/planet-a-ve

Run `pd` to see a list of all commands, or `pd help <command>` to display help docs for a specific command.

See the [CLI reference](/workflows/cli/reference/) for detailed usage and examples for each command.
See the [CLI reference](/components/contributing/cli/reference/) for detailed usage and examples for each command.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If you already have a Pipedream account, run
pd login
```

This will open up a new window in your default browser. If you're already logged into your Pipedream account in this browser, this will immediately link the CLI to your account, writing your API key for that account to your [`pd` config file](/workflows/cli/reference/#cli-config-file).
This will open up a new window in your default browser. If you're already logged into your Pipedream account in this browser, this will immediately link the CLI to your account, writing your API key for that account to your [`pd` config file](/components/contributing/cli/reference/#cli-config-file).

Otherwise, you'll be asked to login.

Expand All @@ -23,7 +23,7 @@ Once you're done, go back to your shell and you should see confirmation that you
Logged in as dylburger ([email protected])
```

Then [follow this guide](/workflows/cli/reference/#creating-a-profile-for-a-workspace) to learn how to find your workspace ID and associate it with a `pd` profile.
Then [follow this guide](/components/contributing/cli/reference/#creating-a-profile-for-a-workspace) to learn how to find your workspace ID and associate it with a `pd` profile.

## Signing up for Pipedream via the CLI

Expand All @@ -33,7 +33,7 @@ If you haven't signed up for a Pipedream account, you can create an account usin
pd signup
```

This will open up a new window in your default browser. You'll be asked to sign up for Pipedream here. Once you do, your account will be linked to the CLI, writing your API key for that account to your [`pd` config file](/workflows/cli/reference/#cli-config-file).
This will open up a new window in your default browser. You'll be asked to sign up for Pipedream here. Once you do, your account will be linked to the CLI, writing your API key for that account to your [`pd` config file](/components/contributing/cli/reference/#cli-config-file).

Once you're done, go back to your shell and you should see confirmation that your account is linked:

Expand All @@ -50,8 +50,8 @@ You can log out of the CLI by running:
pd logout
```

This will remove your API key from the [`pd` config file](/workflows/cli/reference/#cli-config-file).
This will remove your API key from the [`pd` config file](/components/contributing/cli/reference/#cli-config-file).

## Using the CLI to manage multiple accounts

If you have multiple Pipedream accounts, you can use [profiles](/workflows/cli/reference/#profiles) to ensure the CLI can manage resources for each.
If you have multiple Pipedream accounts, you can use [profiles](/components/contributing/cli/reference/#profiles) to ensure the CLI can manage resources for each.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Installing the CLI

[See the CLI installation docs](/workflows/cli/install/) to learn how to install the CLI for your OS / architecture.
[See the CLI installation docs](/components/contributing/cli/install/) to learn how to install the CLI for your OS / architecture.

## Command Reference

Expand Down Expand Up @@ -196,13 +196,13 @@ pd list st

### `pd login`

Log in to Pipedream CLI and persist API key locally. See [Logging into the CLI](/workflows/cli/login/) for more information.
Log in to Pipedream CLI and persist API key locally. See [Logging into the CLI](/components/contributing/cli/login/) for more information.

### `pd logout`

Unsets the local API key tied to your account.

Running `pd logout` without any arguments removes the default API key from your [config file](/workflows/cli/reference/#cli-config-file).
Running `pd logout` without any arguments removes the default API key from your [config file](/components/contributing/cli/reference/#cli-config-file).

You can remove the API key for a specific profile by running:

Expand Down Expand Up @@ -234,7 +234,7 @@ pd publish my-action.js

### `pd signup`

Sign up for Pipedream via the CLI and persist your API key locally. See the docs on [Signing up for Pipedream via the CLI](/workflows/cli/login/#signing-up-for-pipedream-via-the-cli) for more information.
Sign up for Pipedream via the CLI and persist your API key locally. See the docs on [Signing up for Pipedream via the CLI](/components/contributing/cli/login/#signing-up-for-pipedream-via-the-cli) for more information.

### `pd unpublish`

Expand Down Expand Up @@ -279,7 +279,7 @@ Profiles allow you to work with multiple, named Pipedream accounts via the CLI.

### Creating a new profile

When you [login to the CLI](/workflows/cli/login/), the CLI writes the API key for that account to your config file, in the `api_key` field:
When you [login to the CLI](/components/contributing/cli/login/), the CLI writes the API key for that account to your config file, in the `api_key` field:

```bash
api_key = abc123
Expand Down
8 changes: 4 additions & 4 deletions docs-v2/pages/components/contributing/sources-quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ We recommend that you execute the examples in order — each one builds on the c

**Step 1.** Create a free account at [https://pipedream.com](https://pipedream.com). Just sign in with your Google or Github account.

**Step 2.** [Download and install the Pipedream CLI](/workflows/cli/install/).
**Step 2.** [Download and install the Pipedream CLI](/components/contributing/cli/install/).

**Step 3.** Once the CLI is installed, [link your Pipedream account to the CLI](/workflows/cli/login/#existing-pipedream-account):
**Step 3.** Once the CLI is installed, [link your Pipedream account to the CLI](/components/contributing/cli/login/#existing-pipedream-account):

```bash
pd login
```

See the [CLI reference](/workflows/cli/reference/) for detailed usage and examples beyond those covered below.
See the [CLI reference](/components/contributing/cli/reference/) for detailed usage and examples beyond those covered below.

## CLI Development Mode

Expand All @@ -67,7 +67,7 @@ If you need to update a deployed instance of a source, pass it's ID to the `dc`
pd dev --dc dc_123456 components/sources/my-source.mjs
```

See the [CLI reference](/workflows/cli/reference/) for detailed usage and examples beyond those covered below.
See the [CLI reference](/components/contributing/cli/reference/) for detailed usage and examples beyond those covered below.

## Hello World!

Expand Down
2 changes: 1 addition & 1 deletion docs-v2/pages/components/contributing/typescript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The build process should print the compiled JS files to your console and produce

For example, if you compile a TypeScript file at `pipedream/components/rss/sources/new-item-in-feed/new-item-in-feed.ts`, the corresponding JS file will be produced at `pipedream/components/rss/dist/sources/new-item-in-feed/new-item-in-feed.js`.

6. Use [the Pipedream CLI](/workflows/cli/reference/) to `pd publish` or `pd dev` the JavaScript components emitted by step 5 by the full path to the file.
6. Use [the Pipedream CLI](/components/contributing/cli/reference/) to `pd publish` or `pd dev` the JavaScript components emitted by step 5 by the full path to the file.

```bash
pd publish pipedream/components/rss/dist/sources/new-item-in-feed/new-item-in-feed.js
Expand Down
10 changes: 5 additions & 5 deletions docs-v2/pages/components/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,20 +51,20 @@ The Add Single Row action for Google Sheets is a prebuilt component in Pipedream

Components may be instantiated or added to workflows via Pipedream's UI.

- Sources may be instantiated and consumed via [UI](https://pipedream.com/sources/new), [CLI](/workflows/cli/reference/#pd-deploy) or API
- Sources may be instantiated and consumed via [UI](https://pipedream.com/sources/new), [CLI](/components/contributing/cli/reference/#pd-deploy) or API
- Actions may be added to [workflows](https://pipedream.com/new)

### Using Private Actions

Private action components published from the [CLI](/workflows/cli/reference/#pd-publish) or from a [Node.js Code Step](/workflows/building-workflows/code/nodejs/sharing-code/) are available for use across your workflows.
Private action components published from the [CLI](/components/contributing/cli/reference/#pd-publish) or from a [Node.js Code Step](/workflows/building-workflows/code/nodejs/sharing-code/) are available for use across your workflows.

To use a published action, add a new step to your workflow and click **My Actions**. Your privately published action components will appear in this list.

![Use the "My Actions" section in a new step to include your private actions](/images/components/v3/using-private-actions.png)

### Using Private Sources

Private source components deployed from your account via the [CLI](/workflows/cli/reference/#pd-deploy) will automatically create a new Source in your account with the prop configuration you specified.
Private source components deployed from your account via the [CLI](/components/contributing/cli/reference/#pd-deploy) will automatically create a new Source in your account with the prop configuration you specified.

Then in the workflow builder, when creating the trigger, select the *Existing* sources tab in the upper right corner to select your deployed source:

Expand All @@ -76,7 +76,7 @@ You can also deploy new instances of a source from the [Components dashboard](ht

## Developing Components

Develop components locally using your preferred code editor (and maintain your code in your own GitHub repo) and deploy or publish using Pipedream's [CLI](/workflows/cli/reference/#pd-deploy).
Develop components locally using your preferred code editor (and maintain your code in your own GitHub repo) and deploy or publish using Pipedream's [CLI](/components/contributing/cli/reference/#pd-deploy).

- Sources may be deployed directly from local code or published to your account and instantiated via Pipedream's UI
- Actions may only be published — published actions may be added to workflows via Pipedream's UI
Expand All @@ -88,7 +88,7 @@ Published components are only available to your own account by default. If publi
- A free [Pipedream](https://pipedream.com) account
- A free [GitHub](https://github.com) account
- Basic proficiency with Node.js or Javascript
- Pipedream [CLI](/workflows/cli/reference/)
- Pipedream [CLI](/components/contributing/cli/reference/)

Finally, the target app must be integrated with Pipedream. You can explore all apps supported by Pipedream in the [marketplace](https://pipedream.com/explore). If your app is not listed, please [create a GitHub issue](https://github.com/PipedreamHQ/pipedream/issues/new?assignees=&labels=app%2C+enhancement&template=app---service-integration.md&title=%5BAPP%5D) to request it and [reach out](https://pipedream.com/community/c/dev/11) to our team to let us know that you're blocked on source or action development.

Expand Down
Loading
Loading