Skip to content
Draft
Show file tree
Hide file tree
Changes from all 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
4 changes: 2 additions & 2 deletions src/content/cre/getting-started/before-you-build-go.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Here are resources to help you go from simulation to production.
Deploying requires Early Access approval. Run `cre account access` or visit <a href="https://app.chain.link/cre/request-access" target="_blank">app.chain.link/cre/request-access</a> to submit a request. See [Requesting Deploy Access](/cre/account/deploy-access). While you wait, continue building and simulating workflows.
</Aside>

1. **[Link a Wallet Key](/cre/organization/linking-keys)** — Connect your wallet to your organization
1. **[Deploy Your Workflow](/cre/guides/operations/deploying-workflows)** — Push your workflow live
1. **[Deploy Your Workflow](/cre/guides/operations/deploying-workflows)** — Push your workflow live. Set `deployment-registry` in `workflow.yaml` to choose private registry management or the public onchain Workflow Registry.
1. **(Optional) [Link a Wallet Key](/cre/organization/linking-keys)** — Only needed if you set `deployment-registry: "onchain:ethereum-mainnet"`.
1. **[Monitor Your Workflow](/cre/guides/operations/monitoring-workflows)** — Watch it execute and debug issues

### Explore different triggers
Expand Down
4 changes: 2 additions & 2 deletions src/content/cre/getting-started/before-you-build-ts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ Here are resources to help you go from simulation to production.
Deploying requires Early Access approval. Run `cre account access` or visit <a href="https://app.chain.link/cre/request-access" target="_blank">app.chain.link/cre/request-access</a> to submit a request. See [Requesting Deploy Access](/cre/account/deploy-access). While you wait, continue building and simulating workflows.
</Aside>

1. **[Link a Wallet Key](/cre/organization/linking-keys)** — Connect your wallet to your organization
1. **[Deploy Your Workflow](/cre/guides/operations/deploying-workflows)** — Push your workflow live
1. **[Deploy Your Workflow](/cre/guides/operations/deploying-workflows)** — Push your workflow live. Set `deployment-registry` in `workflow.yaml` to choose private registry management or the public onchain Workflow Registry.
1. **(Optional) [Link a Wallet Key](/cre/organization/linking-keys)** — Only needed if you set `deployment-registry: "onchain:ethereum-mainnet"`.
1. **[Monitor Your Workflow](/cre/guides/operations/monitoring-workflows)** — Watch it execute and debug issues

### Explore different triggers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Before you begin, ensure you have the following:
- **CRE CLI**: See the [Installation Guide](/cre/getting-started/cli-installation/macos-linux) for details.
- **CRE account & authentication**: You must have a CRE account and be logged in with the CLI. See [Create your account](/cre/account/creating-account) and [Log in with the CLI](/cre/account/cli-login) for instructions.
- **Go**: You must have Go version 1.25.3 or higher installed. Check your version with <CopyText text="go version" code />. See [Install Go](https://go.dev/doc/install) for instructions.
- **Funded Sepolia Account**: An account with Sepolia ETH to pay for transaction gas fees. Go to <a href="https://faucets.chain.link" target="blank">faucets.chain.link</a> to get some Sepolia ETH.
- **Funded Sepolia Account**: An account with Sepolia ETH to pay for transaction gas fees. Required for [Part 4: Writing Onchain](/cre/getting-started/part-4-writing-onchain), and for any deployment that uses `deployment-registry: "onchain:ethereum-mainnet"`. Not required to simulate workflows or deploy to the `private` registry. Go to <a href="https://faucets.chain.link" target="blank">faucets.chain.link</a> to get some Sepolia ETH.

## Step 1: Verify your authentication

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Before you begin, ensure you have the following:
- **CRE CLI**: See the [Installation Guide](/cre/getting-started/cli-installation/macos-linux) for details.
- **CRE account & authentication**: You must have a CRE account and be logged in with the CLI. See [Create your account](/cre/account/creating-account) and [Log in with the CLI](/cre/account/cli-login) for instructions.
- **Bun**: You must have <a href="https://bun.com/docs" target="blank">Bun</a> version 1.2.21 or higher installed. Check your version with <CopyText text="bun --version" code />. See [Install Bun](https://bun.com) for instructions.
- **Funded Sepolia Account**: An account with Sepolia ETH to pay for transaction gas fees. Go to <a href="https://faucets.chain.link" target="blank">faucets.chain.link</a> to get some Sepolia ETH.
- **Funded Sepolia Account**: An account with Sepolia ETH to pay for transaction gas fees. Required for [Part 4: Writing Onchain](/cre/getting-started/part-4-writing-onchain), and for any deployment that uses `deployment-registry: "onchain:ethereum-mainnet"`. Not required to simulate workflows or deploy to the `private` registry. Go to <a href="https://faucets.chain.link" target="blank">faucets.chain.link</a> to get some Sepolia ETH.

## Step 1: Verify your authentication

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ metadata:

import { Aside } from "@components"

After deploying a workflow, you can control its operational state using the `cre workflow activate` and `cre workflow pause` commands. These commands modify the workflow's status in the Workflow Registry contract, determining whether it can respond to triggers.
After deploying a workflow, you can control its operational state using the `cre workflow activate` and `cre workflow pause` commands. These commands modify the workflow's status in the registry selected by `deployment-registry`, determining whether it can respond to triggers.

**Workflow states:**

Expand All @@ -21,11 +21,12 @@ After deploying a workflow, you can control its operational state using the `cre

Before activating or pausing workflows, ensure you have:

- **A [deployed workflow](/cre/guides/operations/deploying-workflows)**: You must have a workflow that has been successfully deployed to the Workflow Registry.
- **Workflow ownership**: You must be the owner of the workflow (the account that originally deployed it). Only the workflow owner can activate or pause it.
- **A [deployed workflow](/cre/guides/operations/deploying-workflows)**: You must have a workflow that has been successfully deployed to the registry selected by `deployment-registry`.
- **Workflow authorization**: You must be authorized to manage the workflow. Public onchain registry workflows use the linked workflow owner address. Private registry workflows use your CRE organization login session.
- **Local workflow folder**: You must run these commands from your project directory. The CLI reads the workflow name and configuration from your `workflow.yaml` file to identify which workflow to activate or pause.
- **[Logged in](/cre/reference/cli/authentication#cre-login)**: Authenticated with the platform by running `cre login`. To check your authentication status, run `cre whoami`.
- **A funded wallet**: The account you are using must be funded with ETH on Ethereum Mainnet to pay the gas fees for the onchain transaction to the Workflow Registry contract.
- **A `deployment-registry` value**: Updated CLI-generated targets use `private` by default. For older workflow files, make sure the target has `deployment-registry: "private"` or `deployment-registry: "onchain:ethereum-mainnet"`.
- **(Onchain registry only) A funded wallet**: The account you are using must be funded with ETH on Ethereum Mainnet to pay gas for the registry transaction.

## Activating a workflow

Expand All @@ -46,15 +47,16 @@ cre workflow activate my-workflow --target production-settings
The CLI identifies which workflow to activate based on:

- `workflow-name` from your `workflow.yaml` file
- `workflow-owner-address` (either from `workflow.yaml` or derived from your private key in `.env`)
- `deployment-registry` from your `workflow.yaml` file
- `workflow-owner-address` for onchain registry workflows, or your CRE organization for private registry workflows

### What happens during activation

1. The CLI fetches the workflow matching your workflow name and owner address
1. The CLI fetches the workflow matching your workflow name and configured registry authorization
1. It validates that the workflow is currently paused
1. If valid, it sends an onchain transaction to change the status to active
1. If valid, it updates the workflow status in the target's configured registry. For `onchain:ethereum-mainnet`, this sends an onchain transaction. For `private`, this updates the Chainlink-hosted private registry through your CRE login session.

### Example output
### Example onchain registry output

```bash
> cre workflow activate my-workflow --target production-settings
Expand Down Expand Up @@ -114,11 +116,11 @@ cre workflow pause my-workflow --target production-settings

### What happens during pausing

1. The CLI fetches the workflow matching your workflow name and owner address
1. The CLI fetches the workflow matching your workflow name and configured registry authorization
1. It validates that the workflow is currently active
1. If valid, it sends an onchain transaction to change the status to paused
1. If valid, it updates the workflow status in the target's configured registry. For `onchain:ethereum-mainnet`, this sends an onchain transaction. For `private`, this updates the Chainlink-hosted private registry through your CRE login session.

### Example output
### Example onchain registry output

```bash
> cre workflow pause my-workflow --target production-settings
Expand Down Expand Up @@ -162,7 +164,7 @@ Details:

## Using multi-sig wallets

Both `activate` and `pause` commands support multi-sig wallets through the `--unsigned` flag. When using this flag, the CLI generates raw transaction data that you can submit through your multi-sig wallet interface instead of sending the transaction directly.
For onchain registry workflows, both `activate` and `pause` commands support multi-sig wallets through the `--unsigned` flag. When using this flag, the CLI generates raw transaction data that you can submit through your multi-sig wallet interface instead of sending the transaction directly. Private registry workflows do not use `--unsigned` because they do not submit registry transactions.

For complete setup instructions, configuration requirements, and step-by-step guidance, see [Using Multi-sig Wallets](/cre/guides/operations/using-multisig-wallets).

Expand Down
24 changes: 13 additions & 11 deletions src/content/cre/guides/operations/deleting-workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,25 @@ section: cre
date: Last Modified
title: "Deleting Workflows"
metadata:
description: "Remove workflows permanently: learn how to safely delete deployed workflows from the Workflow Registry when no longer needed."
description: "Remove workflows permanently: learn how to safely delete deployed workflows from their configured registry when no longer needed."
datePublished: "2025-11-04"
lastModified: "2025-11-04"
---

import { Aside } from "@components"

Deleting a workflow permanently removes it from the Workflow Registry contract. This action cannot be undone, and the workflow will no longer be able to respond to triggers.
Deleting a workflow permanently removes it from the registry selected by `deployment-registry`. This action cannot be undone, and the workflow will no longer be able to respond to triggers.

## Prerequisites

Before deleting a workflow, ensure you have:

- **A [deployed workflow](/cre/guides/operations/deploying-workflows)**: The workflow must exist in the Workflow Registry.
- **Workflow ownership**: You must be the owner of the workflow (the account that originally deployed it). Only the workflow owner can delete it.
- **A [deployed workflow](/cre/guides/operations/deploying-workflows)**: The workflow must exist in the registry selected by `deployment-registry`.
- **Workflow authorization**: You must be authorized to manage the workflow. Public onchain registry workflows use the linked workflow owner address. Private registry workflows use your CRE organization login session.
- **Local workflow folder**: You must run this command from your project directory. The CLI reads the workflow name and configuration from your `workflow.yaml` file to identify which workflow to delete.
- **[Logged in](/cre/reference/cli/authentication#cre-login)**: Authenticated with the platform by running `cre login`. To check if you are logged in, run `cre whoami`.
- **A funded wallet**: The account must be funded with ETH on Ethereum Mainnet to pay the gas fees for the onchain transaction to the Workflow Registry contract.
- **A `deployment-registry` value**: Updated CLI-generated targets use `private` by default. For older workflow files, make sure the target has `deployment-registry: "private"` or `deployment-registry: "onchain:ethereum-mainnet"`.
- **(Onchain registry only) A funded wallet**: The account must be funded with ETH on Ethereum Mainnet to pay gas for the registry transaction.

## Deleting a workflow

Expand All @@ -33,21 +34,22 @@ cre workflow delete my-workflow --target production-settings
The CLI identifies which workflow to delete based on:

- `workflow-name` from your `workflow.yaml` file
- `workflow-owner-address` (either from `workflow.yaml` or derived from your private key in `.env`)
- `deployment-registry` from your `workflow.yaml` file
- `workflow-owner-address` for onchain registry workflows, or your CRE organization for private registry workflows

### What happens during deletion

1. The CLI fetches all workflows matching your workflow name and owner address
1. The CLI fetches all workflows matching your workflow name and configured registry authorization
1. It displays details about the workflow(s) to be deleted
1. It prompts you to confirm by typing the workflow name
1. Once confirmed, it sends an onchain transaction to delete the workflow from the Workflow Registry
1. Once confirmed, it deletes the workflow from the target's configured registry. For `onchain:ethereum-mainnet`, this sends an onchain transaction. For `private`, this updates the Chainlink-hosted private registry through your CRE login session.

{/* prettier-ignore */}
<Aside type="caution" title="Destructive operation">
**This action cannot be undone.** Once a workflow is deleted from the Workflow Registry, it is permanently removed and can no longer respond to triggers. The CLI requires you to type the workflow name to confirm this destructive operation.
**This action cannot be undone.** Once a workflow is deleted from its configured registry, it is permanently removed and can no longer respond to triggers. The CLI requires you to type the workflow name to confirm this destructive operation.
</Aside>

### Example output
### Example onchain registry output

```bash
> cre workflow delete my-workflow --target production-settings
Expand Down Expand Up @@ -105,7 +107,7 @@ cre workflow delete my-workflow --yes --target production-settings

## Using multi-sig wallets

The `delete` command supports multi-sig wallets through the `--unsigned` flag. When using this flag, the CLI generates raw transaction data that you can submit through your multi-sig wallet interface instead of sending the transaction directly.
For onchain registry workflows, the `delete` command supports multi-sig wallets through the `--unsigned` flag. When using this flag, the CLI generates raw transaction data that you can submit through your multi-sig wallet interface instead of sending the transaction directly. Private registry workflows do not use `--unsigned` because they do not submit registry transactions.

For complete setup instructions, configuration requirements, and step-by-step guidance, see [Using Multi-sig Wallets](/cre/guides/operations/using-multisig-wallets).

Expand Down
Loading
Loading