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

# aplazame/rsync

## Commands

### folder

A simple encapsulation of doing a rsync

| Parameter | Type | Default | Description |
|---|---|---|---|
| `src` | string |  |  |
| `user` | string |  |  |
| `host` | string |  |  |
| `dest` | string |  |  |
| `overwrite` | boolean | true |  |
| `arguments` | string |  |  |

## Jobs

### deploy

| Parameter | Type | Default | Description |
|---|---|---|---|
| `workspace` | string | /tmp/workspace | working directory |
| `executor` | executor | rsync_box | executor for s3_deploy |
| `do_deploy` | steps |  | commands executed after rsync setup |

## Executors

### rsync_box

| Parameter | Type | Default | Description |
|---|---|---|---|
| `image` | string | aplazame/alpine:0.1.10-rsync |  |
| `working_directory` | string | /tmp/workspace |  |