Skip to content

Commit 17bc6ea

Browse files
connect object in apps API (#17094)
* connect object in apps API * Moving the /cli dir out of /workflows, into /components * custom tools * mcp references
1 parent 304c597 commit 17bc6ea

File tree

23 files changed

+312
-62
lines changed

23 files changed

+312
-62
lines changed

docs-v2/next.config.mjs

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -438,17 +438,37 @@ export default withNextra({
438438
},
439439
{
440440
source: "/cli/",
441-
destination: "/workflows/cli/reference/",
441+
destination: "/components/contributing/cli/reference/",
442442
permanent: true,
443443
},
444444
{
445445
source: "/cli/reference/",
446-
destination: "/workflows/cli/reference/",
446+
destination: "/components/contributing/cli/reference/",
447447
permanent: true,
448448
},
449449
{
450450
source: "/cli/login/",
451-
destination: "/workflows/cli/login/",
451+
destination: "/components/contributing/cli/login/",
452+
permanent: true,
453+
},
454+
{
455+
source: "/cli/install/",
456+
destination: "/components/contributing/cli/install/",
457+
permanent: true,
458+
},
459+
{
460+
source: "/cli/:path*",
461+
destination: "/components/contributing/cli/:path*",
462+
permanent: true,
463+
},
464+
{
465+
source: "/workflows/cli/",
466+
destination: "/components/contributing/cli/reference/",
467+
permanent: true,
468+
},
469+
{
470+
source: "/workflows/cli/:path*",
471+
destination: "/components/contributing/cli/:path*",
452472
permanent: true,
453473
},
454474
{

docs-v2/pages/components/contributing/_meta.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ export default {
55
"sources-quickstart": "Quickstart — Sources",
66
"guidelines": "Guidelines",
77
"typescript": "TypeScript components",
8+
"cli": "CLI",
89
} as const

docs-v2/pages/components/contributing/actions-quickstart.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ If you previously developed actions using Pipedream's UI, we recommend reviewing
2222
## Prerequisites
2323

2424
- Create a free account at [https://pipedream.com](https://pipedream.com)
25-
- Download and install the [Pipedream CLI](/workflows/cli/install/)
26-
- 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
25+
- Download and install the [Pipedream CLI](/components/contributing/cli/install/)
26+
- 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
2727

28-
> **NOTE:** See the [CLI reference](/workflows/cli/reference/) for detailed usage and examples beyond those covered below.
28+
> **NOTE:** See the [CLI reference](/components/contributing/cli/reference/) for detailed usage and examples beyond those covered below.
2929
3030
## Walkthrough
3131

docs-v2/pages/components/contributing/api.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Components are Node.js modules that run on Pipedream's serverless infrastructure
2020

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

5050
### Getting Started with the CLI
5151

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

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

5656
### Example Components
5757

@@ -1052,11 +1052,11 @@ pd deploy https://raw.githubusercontent.com/PipedreamHQ/pipedream/master/compone
10521052
10531053
#### CLI - Update
10541054
1055-
View the [CLI command reference](/workflows/cli/reference/#command-reference).
1055+
View the [CLI command reference](/components/contributing/cli/reference/#command-reference).
10561056
10571057
#### CLI - Delete
10581058
1059-
View the [CLI command reference](/workflows/cli/reference/#command-reference).
1059+
View the [CLI command reference](/components/contributing/cli/reference/#command-reference).
10601060
10611061
#### UI - Deploy
10621062

docs-v2/pages/workflows/cli/install.mdx renamed to docs-v2/pages/components/contributing/cli/install.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ The `pd` binary is available via Nix flake [here](https://github.com/planet-a-ve
7777

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

80-
See the [CLI reference](/workflows/cli/reference/) for detailed usage and examples for each command.
80+
See the [CLI reference](/components/contributing/cli/reference/) for detailed usage and examples for each command.

docs-v2/pages/workflows/cli/login.mdx renamed to docs-v2/pages/components/contributing/cli/login.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If you already have a Pipedream account, run
1212
pd login
1313
```
1414

15-
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).
15+
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).
1616

1717
Otherwise, you'll be asked to login.
1818

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

26-
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.
26+
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.
2727

2828
## Signing up for Pipedream via the CLI
2929

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

36-
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).
36+
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).
3737

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

@@ -50,8 +50,8 @@ You can log out of the CLI by running:
5050
pd logout
5151
```
5252

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

5555
## Using the CLI to manage multiple accounts
5656

57-
If you have multiple Pipedream accounts, you can use [profiles](/workflows/cli/reference/#profiles) to ensure the CLI can manage resources for each.
57+
If you have multiple Pipedream accounts, you can use [profiles](/components/contributing/cli/reference/#profiles) to ensure the CLI can manage resources for each.

docs-v2/pages/workflows/cli/reference.mdx renamed to docs-v2/pages/components/contributing/cli/reference.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Installing the CLI
44

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

77
## Command Reference
88

@@ -196,13 +196,13 @@ pd list st
196196

197197
### `pd login`
198198

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

201201
### `pd logout`
202202

203203
Unsets the local API key tied to your account.
204204

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

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

@@ -234,7 +234,7 @@ pd publish my-action.js
234234

235235
### `pd signup`
236236

237-
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.
237+
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.
238238

239239
### `pd unpublish`
240240

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

280280
### Creating a new profile
281281

282-
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:
282+
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:
283283

284284
```bash
285285
api_key = abc123

docs-v2/pages/components/contributing/sources-quickstart.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ We recommend that you execute the examples in order — each one builds on the c
3636

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

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

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

4343
```bash
4444
pd login
4545
```
4646

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

4949
## CLI Development Mode
5050

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

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

7272
## Hello World!
7373

docs-v2/pages/components/contributing/typescript.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The build process should print the compiled JS files to your console and produce
4444

4545
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`.
4646

47-
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.
47+
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.
4848

4949
```bash
5050
pd publish pipedream/components/rss/dist/sources/new-item-in-feed/new-item-in-feed.js

0 commit comments

Comments
 (0)