CI, the GitHub Action and the SDK

The GitHub Action

The action runs one request on a CI runner, uploads the event log and puts the walkthrough in the step summary. The step fails with the command line’s exit code.

- uses: ./.github/actions/maxtkn
  with:
    prompt: "Fix the failing tests"
    model: claude-sonnet-5-5
    verify: "true"
  env:
    ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}

It has two outputs: exit-code and summary (how the run ended, in one line). Keys come from the environment only, never from an input.

The SDK

The SDK is the same engine as the command line, as a function for your own scripts and tests. It streams events as the team works and resolves with the outcome.

import { run } from './sdk';

const { events, result } = run({
  prompt: 'add a contact form',
  project: '.',
  team: 'solo',
  model: 'demo',
});

for await (const ev of events) {
  if (ev.kind === 'file_change') console.log('changed', ev.data.path);
}

const outcome = await result;
console.log(outcome.summary);
process.exitCode = outcome.exitCode;

• Options mirror the command line: goal (with maxRounds) keeps working until checks pass, and worktree: true or a branch name works in an isolated copy and applies nothing.
• readEventLog reads a saved .maxtkn/runs log back.
• The outcome includes the exit code, a one-line summary and, for a worktree run, the copy’s folder and branch.

Run on a schedule with your operating system

Scheduled tasks in the app run only while Maxtkn is open. To run a task when it is closed, open the task in Scheduled tasks and use Run even when Maxtkn is closed. It writes the command for Windows schtasks, a macOS launchd snippet or a Linux crontab line, with a Copy button. The command runs the command line with the task’s project, request, team, model and time limit, never contains a key (only the name of the variable), and uses --profile read-only unless the task works in an isolated copy, in which case it uses --worktree.

See Goals and scheduled tasks for the rules, and The maxtkn command line for every option.