Skip to content

AGENTS.md

Latest commit

 

History

History
51 lines (37 loc) · 1.63 KB

AGENTS.md

File metadata and controls

51 lines (37 loc) · 1.63 KB

Agent Guidelines

This project cross-compiles to Linux, macOS, and Windows. Follow these rules.

Paths

  • Use filepath.Join() for all path construction
  • Use os.TempDir() instead of hardcoded /tmp
  • Use filepath.Separator if you need the separator character
  • Never hardcode / or \ as path separators

OS-Specific Code

  • Use build tags for platform-specific files: //go:build linux, //go:build darwin, //go:build windows
  • Check runtime.GOOS for runtime platform detection
  • Skip platform-specific tests with t.Skip() when features aren't available

Common Platform Differences

Feature Linux macOS Windows
Unix sockets Yes Yes No
PTY /dev/ptmx /dev/ptmx ConPTY
Resource limits cgroups RLIMIT_* Job Objects
Signals Full POSIX Full POSIX Limited
$0 / argv[0] Works Works Different

Testing

  • Run GOOS=windows go build ./... to verify Windows compilation
  • Tests using Unix sockets, POSIX signals, or shell features should skip on Windows
  • Use t.TempDir() for test directories (auto-cleaned)

CI-Specific Issues

ConPTY tests hang in CI: Windows ConPTY doesn't properly signal EOF in non-interactive environments. Tests using ConPTY should skip in CI:

func skipInCI(t *testing.T) {
    t.Helper()
    if os.Getenv("CI") != "" || os.Getenv("GITHUB_ACTIONS") != "" {
        t.Skip("skipping ConPTY test in CI")
    }
}

Environment Variables

  • Use os.Getenv() / os.Setenv()
  • On Windows, env vars are case-insensitive but Go preserves case
  • Use os.Environ() to get the full environment as KEY=value slice