GitHub

​

What Cymph uses it for

Cymph uses GitHub for three purposes, all driven by a single access token:

1. Fetching playbooks / content — reads repositories, branches, and files to import playbooks and other content into Cymph. (read)
2. Backups — commits playbook backups into a repository on a schedule or on demand. (write) See Back up playbooks to GitHub.
3. Publishing documentation — commits a playbook’s documentation into a repository as Markdown or PDF. (write) See Deploy playbooks.

A single token can serve any combination of these depending on which repositories you point Cymph at. Cymph connects to github.com (no instance URL field). Because the repo scope is required in all cases (see below), publishing needs no additional permissions beyond what the integration already asks for.

​

Requirements

​

Token setup

Create a token with the required scope using this pre-filled link: 👉 Create a Cymph integration token This grants the repo scope, which covers both read (fetching playbooks) and write (committing backups) on private repositories. If you use a fine-grained personal access token instead, grant it Contents: Read and write on the target repositories.

​

Permissions

​

What Cymph reads and writes

​

Publishing formats

GitHub accepts both documentation formats: Image blocks are omitted from the Markdown format.

​

Testing the connection

Cymph validates the connection by listing the authenticated user’s repositories.