Tenki GitHub Actions Runner

A small, public helper for setting up and checking GitHub Actions workflows that run on Tenki Cloud.

This project follows the official Tenki Runners documentation only. It does not implement Tenki authentication, store credentials, or call undocumented APIs. The official tenki CLI is for Sandbox; Tenki Runners are connected through the Tenki dashboard and GitHub App.

Upgrading from 0.1.0: That prototype used an undocumented authentication flow and may have written a credential locally. Version 0.2.0 never reads it. Run npx --yes github:hashbender/tenki-github-actions-runner cleanup-legacy-auth, then use the official API key guide to review and revoke any obsolete key.

Quick start

Node.js 20 or newer is required. Run:

npx --yes github:hashbender/tenki-github-actions-runner setup

The command opens the Tenki dashboard and prints the documented setup flow:

1. Sign in and select Runners.
2. Connect your GitHub organization and choose repository access.
3. Use the dashboard's Migration Wizard, or change runs-on manually.

The default recommendation is the documented medium Linux runner:

jobs:
  test:
    runs-on: tenki-standard-medium-4c-8g
    steps:
      - uses: actions/checkout@v7
      - run: npm test

Tenki's documentation requires one Tenki label as the complete runs-on value. Do not combine it with self-hosted, linux, or other labels.

Commands

Command	Purpose
setup	Open the official dashboard and print the documented connection steps
check	Structurally inspect local workflow jobs.*.runs-on values
sizes	List the standard labels published in the official documentation
repository-access	Open the official guide for changing GitHub App repository access
docs	Open the official Tenki Runners quickstart
cleanup-legacy-auth	Remove the exact credential file written by version 0.1.0

Examples:

# Recommend a larger documented runner during setup
npx --yes github:hashbender/tenki-github-actions-runner setup \
  --runner tenki-standard-large-8c-16g

# Inspect workflows in the current repository
npx --yes github:hashbender/tenki-github-actions-runner check

# Machine-readable local inspection
npx --yes github:hashbender/tenki-github-actions-runner check --json

# Print documented labels
npx --yes github:hashbender/tenki-github-actions-runner sizes

check is deliberately local. It parses workflow YAML and reports documented Tenki labels, unsupported label arrays, non-Tenki targets, and values that need manual review. The official documentation does not publish a Runner installation-status API; remote state belongs in the Tenki Runners dashboard. The retired status command fails instead of silently returning a different schema.

Runner labels

The tool includes the Linux x64 and Apple Silicon labels from the official Runner Sizes & Labels page. Run sizes for the current bundled list and use the linked documentation as the source of truth. The retired labels command fails instead of substituting this static list for the old workspace-specific output.

For sizing guidance, see Which Runner to use?.

Repository access

Tenki repository access is controlled by the Tenki GitHub App. The documented path is:

GitHub Settings → Applications → Installed GitHub Apps → Tenki → Configure

From there, adjust Repository access and save. Tenki reflects repository-access changes automatically. See Manage your GitHub Repositories. This helper does not automate or make claims about full app teardown because that is outside the documented Runner flow.

Security

This helper opens official dashboard and documentation URLs. It does not request, receive, or persist a Tenki session token or API key. The opt-in cleanup-legacy-auth command deletes only the exact config file written by version 0.1.0 and never reads its contents.

Development

npm install
npm run check
node dist/cli.js --help

The repository's own CI runs on tenki-standard-medium-4c-8g.

License

MIT