Documentation for GitHub Action

cli/index.md

@@ -1,9 +1,10 @@
 Command Line Interface (CLI)
 ====
 
 :::{toctree}
 :hidden:
 :titlesonly:
+docker
 support
 :::
 
@@ -151,6 +152,16 @@
 ::::
 :::::
 
+### Docker Image
+
+_Cyberduck CLI_ is available as a Docker Image. Install from the command line with
+
+    docker pull ghcr.io/iterate-ch/cyberduck:latest
+
+### GitHub Action
+
+_[Cyberduck CLI GitHub Action](https://github.com/iterate-ch/cyberduck-cli-action)_ is available for [GitHub Actions](https://github.com/features/actions). It runs Cyberduck CLI within a docker container. Refer to [Use Cyberduck CLI GitHub Action](../tutorials/cli_github_action.md).
+
 ## Usage
 
 `Usage:duck [options...]`
@@ -408,6 +419,14 @@
 duck  --move protocol:/<folder>/<name> <file>
 ```
 
+### Copy files using `--copy`
+
+You can copy files using the `--copy` command. Use an absolute path for the target filename. Server-side [copy support](../cyberduck/copy.md#copy-files-and-folders-between-servers) is limited to some protocols.
+
+```{code-block}
+duck  --copy protocol:/<folder>/<name> <file>
+```
+
 ### Cryptomator
 
 Access to your [Cryptomator](../cryptomator/index.md) Vaults from the command line. When accessing a vault using

tutorials/cli_github_action.md

@@ -0,0 +1,46 @@
+Use Cyberduck CLI GitHub Action
+===
+
+> The universal file transfer tool `duck` runs in your shell on Linux and OS X or your Windows command line prompt 
+> for GitHub Actions conveniently in a docker container.
+
+
+## Usage
+
+You add the `cyberduck-cli-action` action to a [GitHub Action](https://docs.github.com/en/actions) workflow with a step like 
+
+    - name: Upload
+      uses: iterate-ch/cyberduck-cli-action@v1
+      env:
+          USERNAME: ${{secrets.S3_ACCESS_KEY}}
+          PASSWORD: ${{secrets.S3_SECRET_KEY}}
+      with:
+          mode: upload
+          url: 's3:/bucket/path/'
+          path: 'target/Release/*'
+          args: '--verbose'
+
+Several modes are supported like `download`, `list` and `upload` probably the most common usage. For `upload` the 
+`url` input option requires must be a valid URI that references the protocol, optional server and destination upload file or directory as [documented](https://docs.duck.sh/cli/#uri). For [S3](https://docs.duck.sh/protocols/s3/) this would be `s3://<hostname>/<bucket>/<key>` or for [SFTP](https://docs.duck.sh/protocols/sftp/) `sftp://<server>/<directory>/
+
+The example assumes you have `S3_ACCESS_KEY` and `S3_SECRET_KEY` defined as a [secret](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions).
+
+:::{tip}
+Make sure to include a trailing `/` in `url` input to denote a directory.
+:::
+
+Any of the available [generic options](https://docs.duck.sh/cli/#generic-options) can be passed with the `args` input.
+
+Another usage would be to work with a list of files retrieved from a S3 bucket available and reference
+using the key `log` using `jobs.<job_id>.outputs.log` [output](https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions#outputsoutput_id).
+
+    - id: list
+      uses: iterate-ch/cyberduck-cli-action@v1
+      with:
+          mode: list
+          url: 's3:/profiles.cyberduck.io/'
+    - run: echo "${{ steps.list.outputs.log }}"
+
+## References 
+
+* Cyberduck CLI GitHub Action [README](https://github.com/iterate-ch/cyberduck-cli-action/blob/main/README.md)

tutorials/index.md

@@ -9,6 +9,7 @@ custom_oauth_client_id
 iam
 vault_localdisk
 sftp_publickeyauth
+cli_github_action
 :::
 
 Find detailed step-by-step instructions for setup, connecting and most common use-cases as well as tutorials for more complicated workarounds.
@@ -26,4 +27,7 @@ IAM allows you to create credentials for third parties accessing your S3 account
 Both [Cyberduck](../cyberduck/index.md) and [Mountain Duck](../mountainduck/index.md) support accessing vaults on your local disk.
 
 ## [Configure Public Key Authentication for SFTP](sftp_publickeyauth.md)
-Configure Public Key Authentication for SFTP using OpenSSH tools.
+Configure Public Key Authentication for SFTP using OpenSSH tools.
+
+## [Use Cyberduck CLI GitHub Action](cli_github_action.md)
+Use Cyberduck CLI Docker Container in GitHub Actions