> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# pipe-cd/pipecd

Install and configure the PipeCD CLI (pipectl CLI).


## Commands

### event-register

Register an event that can be used by EventWatcher.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api-address` | env_var_name | PIPECD_API_ADDRESS | The address to control-plane api. |
| `api-key` | env_var_name | PIPECD_API_KEY | The api key used while authenticating with control-plane. |
| `attach-workspace` | boolean | false | Boolean for whether or not to attach to an existing workspace. Default is false.
 |
| `data` | string |  | The event data. |
| `event-name` | string |  | The event name. |
| `labels` | string |  | The comma-separated list of labels for the event. Format: key=value,key2=value2. |
| `workspace-root` | string | . | Workspace root path that is either an absolute path or a path relative to the working directory. Defaults to '.' (the working directory).
 |

## Executors

### default

This is a simple executor for using pipectl.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `resource_class` | string | small |  |
| `tag` | string | v0.23.0 | Pick a specific pipecd/pipectl image variant: https://github.com/pipe-cd/pipe/releases
 |

## Examples

### event-register

Register an event that can be used by EventWatcher.

```yaml
version: '2.1'
orbs:
  pipecd: pipe-cd/pipecd@1.0.0
jobs:
  register-event:
    executor: pipecd/default
    steps:
      - pipecd/event-register:
          data: gcr.io/pipecd/example:v0.1.0
          name: example-image-pushed
workflows:
  register_event:
    jobs:
      - register-event
```