Merge branch 'add-cwd'

README.md

@@ -2,6 +2,8 @@
 
 This action wraps the CrabNebula Cloud CLI to be used as a GitHub Action.
 
+The documentation for the CrabNebula Cloud can be found [here](https://docs.crabnebula.dev/). It includes information on [how to install the CLI](https://docs.crabnebula.dev/cloud/cli/) and how to use it as well as [example workflows](https://docs.crabnebula.dev/cloud/continuous-integration/) for this action.
+
 ## Example
 
 ```yml

action.yml

@@ -7,6 +7,10 @@ inputs:
   api-key:
     description: 'API key with write permissions for CrabNebula Cloud'
     required: true
+  path:
+    description: 'Optional path to run the CLI in, needs to be a valid directory path (Unix syntax)'
+    required: false
+    default: '.'
 
 outputs:
   stdout:
@@ -15,19 +19,20 @@ outputs:
 
 runs:
   using: 'composite'
-
   steps:
     - name: Download CLI (unix)
       shell: bash
       if: runner.os == 'Linux' || runner.os == 'macOS'
       run: |
+        cd ${{ inputs.path }}
         curl -L https://cdn.crabnebula.app/download/01HKMY6ZXJA3P0QHA5GQY8KKRT/latest/cn_${{ runner.os == 'Linux' && 'linux' || 'macos' }} --output cn
         chmod +x cn
 
     - name: Download CLI (Windows)
       shell: bash
       if: runner.os == 'Windows'
       run: |
+        cd ${{ inputs.path }}
         curl -L https://cdn.crabnebula.app/download/01HKMY6ZXJA3P0QHA5GQY8KKRT/latest/cn_windows.exe --output cn
 
     - name: "Run Command"
@@ -36,6 +41,7 @@ runs:
       env:
         CN_API_KEY: ${{ inputs.api-key }}
       run: |
+        cd ${{ inputs.path }}
         OUTPUT=$(./cn ${{ inputs.command }})
         echo "stdout<<nEOFn" >> $GITHUB_OUTPUT
         echo "$OUTPUT" >> $GITHUB_OUTPUT