Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Share and administer admin write-back

kater admin write-back

Writes Kater's shared layer back to a GitHub repository, as one pull request into the default branch.

Write-back is optional and one-way: nothing in GitHub comes back into Kater. It needs the settings:manage permission, which only the Admin role has. See GitHub and Content store and GitHub write-back.

Commands

CommandWhat it does
kater admin write-back statusShow the connected repository and the last run.
kater admin write-back connectConnect a GitHub repository to write back to.
kater admin write-back disconnectStop writing back and forget the repository. What is already in GitHub stays.
kater admin write-back runWrite back now.

What write-back writes

  • Each connection’s modeling/ folder. That is the shared layer, and the source datasets that it reads. Kater never writes workspaces, apps or Personal folders.
  • One folder of your repository. Each run replaces that folder, such as kater/, on top of the latest commit of the default branch.
  • One branch and one pull request. Kater force-pushes the result to the kater/shared branch, and keeps one pull request open into the default branch. You merge it.
  • Nothing comes back. Kater does not read changes made in GitHub, and the next write-back undoes them.

Where it runs

Run it in your own terminal. The Kater MCP’s kater tool and the Files terminal in Kater do not run it.

Examples

Terminal window
# Connect a repository, step by step
kater admin write-back connect
# See where write-back goes and how it last ran
kater admin write-back status
# Write back now
kater admin write-back run

See also