Ustaw runnera

Runner jest oprogramowaniem typu open source vps-agent CLI instalujesz na własnej maszynie lub VPS. Rejestruje się w SprintFlint, ankiety dla Autoplay zadania, uruchamia narzędzie kodujące (domyślnie Claude Code) w skonfigurowanym drzewie roboczym lub klonie i otwiera pull request. Runner nigdy sam nie scala kodu; przeglądasz i scalasz go samodzielnie.

Warunki wstępne

Zainstaluj je na hoście przed zarejestrowaniem runnera:

Gdzie to uruchomić - Wszędzie z wychodzącym HTTPS do SprintFlint: zapasowy laptop, pudełko deweloperskie lub VPS w chmurze. Moduł uruchamiający tworzy tylko połączenia wychodzące, więc nie są wymagane żadne porty przychodzące.

Zainstaluj

Zainstaluj globalnie CLI za pomocą npm:

npm install -g vps-agent

Sprawdź, czy znajduje się na Twojej ścieżce:

vps-agent --version

Zarejestruj się

Rejestracja łączy runnera z Twoją organizacją SprintFlint. Istnieją dwa tryby.

Tryb tokena (zalecany)

Wygeneruj token rejestracyjny na stronie konfiguracji runnera w SprintFlint, a następnie zarejestruj się za jego pomocą:

vps-agent register \
  --token <token> \
  --api-url https://sprintflint.com

Otwórz Runnery w SprintFlint utwórz runnera i skopiuj jego token rejestracyjny. Token zarówno identyfikuje runnera, jak i go uwierzytelnia; zachowaj to w tajemnicy.

Tryb identyfikatora organizacji

Jeśli wolisz nadać nazwę runnerowi podczas rejestracji, użyj identyfikatora swojej organizacji:

vps-agent register \
  --org-id <id> \
  --name <name>

Uruchom runnera

Rozpocznij odpytywanie ofert pracy na pierwszym planie:

vps-agent start

Aby działał w tle (w przypadku VPS lub hosta o długim czasie działania), użyj trybu demona:

vps-agent start --daemon

Po uruchomieniu runner wysyła sygnały aktywności i jest wyświetlany jako w Internecie w SprintFlint. Teraz pobiera zadania Autoplay dla Twojej organizacji.

Stan, dzienniki i zatrzymanie

PolecenieCo to robi
vps-agent statusPokaż, czy runner działa i jest podłączony
vps-agent logsWydrukuj najnowsze dzienniki runnerów
vps-agent logs -fŚledź logi na żywo (przydatne podczas wykonywania zadania)
vps-agent stopZatrzymaj runnera
vps-agent doctorSprawdź wymagania wstępne, konfigurację i łączność

Skorzystaj ponownie z płatności lokalnej

Domyślnie moduł uruchamiający klonuje repozytorium do nowego katalogu zadań. Jest to powolne i pomija lokalne sekrety (na przykład Rails master.key). Skonfiguruj ścieżkę projektu na stronie edycji projektu — lub zastąp ścieżkę w tym module runner — a ładunek zadania poinformuje moduł uruchamiający o użyciu git worktree add zamiast tego z tej kasy.

Pozostałe zachowanie dodawania/usuwania drzewa roboczego jest zaimplementowane w vps-agent. Ta aplikacja Railsowa wysyła source_mode, project_path, worktree_base, i use_worktree na każdym next_job / job assignment.

Wybór narzędzia kodującego

The narzędzie kodujące to narzędzie kodujące, które uruchamia runner, aby zaimplementować problem. Ustaw harness klucz konfiguracyjny:

Tryby uprawnień

The permission_mode klucz konfiguracji określa, ile narzędzie kodujące może zrobić bez pytania o zgodę:

Uwierzytelnianie Git

Runner korzysta z należących do hosta git i gh Dane uwierzytelniające CLI umożliwiające sklonowanie repozytorium, wypchnięcie gałęzi i otwarcie pliku PR. Uwierzytelnij się raz na hoście przed uruchomieniem agenta:

gh auth login

vps-agent doctor weryfikuje to, a agent odmawia uruchomienia if gh nie jest uwierzytelniony. SprintFlint nigdy nie obsługuje twoich danych uwierzytelniających GitHub.

Najmniejszy przywilej - runner wysyła zmiany przy użyciu konta GitHub hosta, więc nadaj temu kontu tylko niezbędny dostęp do repozytorium. Runner uruchamia Twoje narzędzie kodujące na Twoim sprzęcie; traktuj go jak każdy proces roboczy CI.

Rozwiązywanie problemów

Zacznij od doctor

vps-agent doctor sprawdza typowe punkty awarii i zgłasza, co jest nie tak:

vps-agent doctor

Runner wyświetla się w trybie offline

Zadania stoją w kolejce, ale nigdy nie są uruchamiane

PR nie jest otwarty

Następne kroki