# appleboy/ssh-action architecture

> Architecture diagram of the GitHub repository appleboy/ssh-action, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-21). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/appleboy/ssh-action
- Repository: https://github.com/appleboy/ssh-action

## Overview

SSH for GitHub Actions is an action for running commands on remote hosts from a GitHub Actions workflow. The documented path is workflow configuration, SSH command execution, and optionally captured stdout for later workflow steps. Its README also describes multi-host, authentication, proxy/jump-host, and environment-transfer capabilities. Source excerpts were not provided, so internal handoffs and implementation details are not asserted beyond documented behavior.

Main entry points: [`action.yml`](https://github.com/appleboy/ssh-action/blob/master/action.yml) (Action inputs), [`entrypoint.sh`](https://github.com/appleboy/ssh-action/blob/master/entrypoint.sh) (Action entrypoint)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_action["Action interface"]
  node_action_config["Action inputs<br/>[action.yml]"]
  node_launcher["Action entrypoint<br/>[entrypoint.sh]"]
end

subgraph group_execution["SSH execution"]
  node_drone_ssh["drone-ssh execution"]
  node_remote_hosts(("Remote hosts"))
  node_proxy(("Proxy / jump host"))
  node_commands["Remote commands"]
end

subgraph group_results["Workflow results"]
  node_stdout["Captured stdout"]
end

node_workflow(("GitHub Actions workflow"))
node_workflow_output(("Later workflow steps"))

node_workflow -->|"configures"| node_action_config
node_action_config -.->|"launches"| node_launcher
node_launcher -.->|"invokes"| node_drone_ssh
node_drone_ssh -->|"executes over SSH"| node_remote_hosts
node_drone_ssh -->|"runs"| node_commands
node_drone_ssh -.->|"may connect via"| node_proxy
node_drone_ssh -->|"captures optionally"| node_stdout
node_stdout -->|"provides to"| node_workflow_output

click node_action_config "https://github.com/appleboy/ssh-action/blob/master/action.yml"
click node_launcher "https://github.com/appleboy/ssh-action/blob/master/entrypoint.sh"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_action_config,node_launcher toneBlue
class node_drone_ssh,node_remote_hosts,node_proxy,node_commands toneAmber
class node_stdout toneMint
class node_workflow,node_workflow_output toneIndigo
```

## Components

### Action interface

- [Action inputs](https://github.com/appleboy/ssh-action/blob/master/action.yml): `action.yml`
- [Action entrypoint](https://github.com/appleboy/ssh-action/blob/master/entrypoint.sh): `entrypoint.sh`

### SSH execution

- **drone-ssh execution**
- **Remote hosts**
- **Proxy / jump host**
- **Remote commands**

### Workflow results

- **Captured stdout**

### Other components

- **GitHub Actions workflow**
- **Later workflow steps**

## Connections

- GitHub Actions workflow → Action inputs: configures (evidence: `README.md`)
- Action inputs → Action entrypoint: launches
- Action entrypoint → drone-ssh execution: invokes
- drone-ssh execution → Remote hosts: executes over SSH (evidence: `README.md`)
- drone-ssh execution → Remote commands: runs (evidence: `README.md`)
- drone-ssh execution → Proxy / jump host: may connect via (evidence: `README.md`)
- drone-ssh execution → Captured stdout: captures optionally (evidence: `README.md`)
- Captured stdout → Later workflow steps: provides to (evidence: `README.md`)
