Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1015 Bytes

README.md

File metadata and controls

36 lines (23 loc) · 1015 Bytes

Remote SSH Commands

Simple GitHub Action to run a command on a remote server using SSH. This is working with the latest GitHub Actions.

✨ Example Usage

Example using OpenSSH private key

- name: ls -a via ssh
  uses: tarunjangra/ssh-remote-cmd@v1
  with:
    command: |
      cd /tmp
      ls -a
    host: ${{ secrets.HOST }}
    user: root
    key: ${{ secrets.PRIVATE_KEY}}

Options

  • host - string - Hostname or IP address of the server. Default: 'localhost'

  • port - integer - Port number of the server. Default: 22

  • user - string - Username for authentication. Default: (root)

  • key - string - Required, that contains a private key for either key-based or hostbased user authentication (OpenSSH format). Default: (none)

  • pass - string - Password for authentication.

  • args - string - SSH parameters for example: -tt.

Password and Private Key can only be configured one item