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

# circleci/waypoint

Utilize Hashicorp's Waypoint within your CircleCI jobs!


## Commands

### destroy

Destroy a Waypoint project

| Parameter | Type | Default | Description |
|---|---|---|---|
| `workspace` | string |  | Workspace to work in for this deployment.
 |

### init

Install and initialize Waypoint

| Parameter | Type | Default | Description |
|---|---|---|---|
| `version` | string | 0.1.4 | Version of the waypoint binary to download |
| `workspace` | string |  | Workspace to work in for this deployment.
 |

### up

Build, deploy and release your project.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `bundle_steps` | boolean | false | Run all steps individually, or all together (using "up"), bundling together the output.
 |
| `workspace` | string |  | Workspace to work in for this deployment.
 |

## Jobs

### deploy

Simple job to automatically deploy your application using Waypoint.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `image` | string | cimg/base:2020.11 | Docker image in which this job should execute. |
| `setup` | steps |  | Steps to take before initializing Waypoint and deploying the site. |
| `workspace` | string |  | Workspace to work in for this deployment.
 |

## Examples

### basic_deploy

A basic workflow to deploy your project using waypoint.


```yaml
version: '2.1'
orbs:
  waypoint: circleci/waypoint@x.y
workflows:
  deploy_using_waypoint:
    jobs:
      - waypoint/deploy
```

### deploy_with_setup

A workflow to deploy your project using waypoint, with setup steps.


```yaml
version: '2.1'
orbs:
  waypoint: circleci/waypoint@x.y
workflows:
  deploy_using_waypoint:
    jobs:
      - waypoint/deploy:
          setup:
            - run: wget https://example.com/some-deploy-script.sh
            - run: ./some-deploy-script.sh
```