ghatree

Visualize GitHub Actions workflow dependencies as a tree structure.

Usage

You can run it with npx.

$ npx ghatree@latest

ghatree internally uses the GitHub REST API to retrieve GitHub Actions information. You can set the token for the GitHub REST API using the GITHUB_TOKEN environment variable.

$ GITHUB_TOKEN=<YOUR_TOKEN> npx ghatree@latest

By default, ghatree outputs the GitHub Actions workflow dependencies for the repository in the current directory. To specify a remote repository, use the --repo flag.

$ npx ghatree@latest --repo koki-develop/ghatree

To output in JSON format, use the --json flag.

$ npx ghatree@latest --json

<details><summary>Output Example</summary>

{
  "type": "repository",
  "repository": {
    "owner": "koki-develop",
    "name": "ghatree"
  },
  "dependencies": [
    {
      "type": "workflow",
      "repository": {
        "owner": "koki-develop",
        "name": "ghatree"
      },
      "path": ".github/workflows/ci.yml",
      "dependencies": [
        {
          "type": "job",
          "name": "lint",
          "dependencies": [
            {
              "type": "action",
              "repository": {
                "owner": "actions",
                "name": "checkout"
              },
              "ref": "11bd71901bbe5b1630ceea73d27597364c9af683",
              "dependencies": []
            },
            // ...
          ]
        },
        // ...
      ]
    },
    // ...
  ]
}

</details>

License

MIT