Skip to content

setup.md

Latest commit

 

History

History
77 lines (53 loc) · 4.69 KB

setup.md

File metadata and controls

77 lines (53 loc) · 4.69 KB
Raw
title `glab govern setup`
stage AI Clients
group Developer Clients
info To determine the technical writer assigned to the Stage/Group associated with this page, see <https://handbook.gitlab.com/handbook/marketing/product-and-technical-marketing/technical-writing/#assignments>

Configure this machine to record AI agent sessions. (EXPERIMENTAL)

Synopsis

Configure the current machine for AI governance session capture.

Choose the agents to sync with --agents. Without it, setup syncs the agents set up by an earlier run, or Claude Code if there are none. For each agent, setup installs:

  • Claude Code (claude-code): a Stop hook in ~/.claude/settings.json, which syncs the session after every agent turn, and a SessionEnd hook, which syncs the session and marks it completed.
  • OpenCode (opencode), version 1.4 or later: a plugin in ~/.config/opencode/plugins/glab-govern.js (under $XDG_CONFIG_HOME when it is set), which syncs the session every time it goes idle. OpenCode loads it for all your sessions, in every project. Later setups keep it up to date.
  • Codex (codex) and Cursor (cursor): nothing. The fallback periodic sync finds their sessions by scanning their transcripts in ~/.codex/sessions and ~/.cursor/projects, including sessions from before you enabled them, and uploads those from repositories on GitLab hosts you are logged in to with glab. Their sessions are marked completed once they have been idle for 24 hours.

Setup also installs the fallback periodic sync: a launchd agent (~/Library/LaunchAgents/com.gitlab.glab-govern-audit-sync.plist) on macOS, or a systemd user timer (~/.config/systemd/user/glab-govern-audit-sync.timer) on Linux.

The fallback periodic sync runs glab govern audit sync --all every 30 minutes, and on Linux also 5 minutes after boot, until you remove it. It uploads anything the hooks missed for sessions they have already recorded (see glab govern audit sync --help for what is uploaded), using your stored glab credentials and the glab configuration directory in use when you run setup. Each session goes to the project and host of the Git repository the agent ran in. It also marks sessions completed once they have been idle for 24 hours. It pauses sessions from agents that use hooks while those hooks are not installed. Pass --no-fallback-sync to install only the hooks and plugin, which Codex and Cursor cannot be synced without. The fallback periodic sync is not available on Windows.

Run setup again with --agents to add agents. Agents set up by an earlier run stay set up, so to stop syncing an agent, run --uninstall and then set up the agents you want. Every setup prompt names the agents that are synced.

Safe to run multiple times: existing hooks are not duplicated, and an existing fallback periodic sync job is replaced. Run glab govern doctor afterwards to verify the setup.

Run glab govern setup --uninstall to remove everything setup installed: the hooks, the OpenCode plugin, the fallback periodic sync job, and Codex and Cursor session syncing. It also forgets the agents you set up, so the next setup starts with Claude Code again. Other hooks and settings in ~/.claude/settings.json, and other OpenCode plugins, are left unchanged.

This feature is an experiment and is not ready for production use. It might be unstable or removed at any time. For more information, see https://docs.gitlab.com/policy/development_stages_support/.

glab govern setup [flags]

Examples

# Sync Claude Code sessions, or the agents set up earlier
$ glab govern setup

# Sync OpenCode sessions
$ glab govern setup --agents opencode

# Sync Claude Code, OpenCode, and Codex sessions
$ glab govern setup --agents claude-code,opencode,codex

# Install only the hooks and plugin, without the fallback periodic sync
$ glab govern setup --no-fallback-sync

# Remove everything setup installed
$ glab govern setup --uninstall

Options

      --agents strings     Agents to sync sessions from: claude-code, opencode, codex, cursor. Added to the agents set up by an earlier run. The OpenCode plugin runs for all your OpenCode sessions. Multiple agents can be comma-separated or specified by repeating the flag.
      --no-fallback-sync   Install only the hooks and plugin, without the fallback periodic sync job.
      --uninstall          Remove the hooks, the OpenCode plugin, and the fallback periodic sync job, and stop syncing Codex and Cursor sessions.
  -y, --yes                Skip confirmation prompt.

Options inherited from parent commands

  -h, --help   Show help for this command.