scitex-agent-container

Getting Started

  • Installation
    • From PyPI
    • From Source
    • Requirements
  • Quickstart
  • Templates and Examples
    • Pattern Templates
    • Instantiating a Template
    • Examples
  • SLURM Runtimes
    • Single-agent (runtime: slurm)
    • Multi-tenant (runtime: slurm-tenant)
      • Step 1 — book the reservation
      • Step 2 — write tenant YAMLs
      • Step 3 — start agents into the allocation
      • Step 4 — operate them
    • Architectural notes
    • Migration path
    • Troubleshooting
  • Status and Hook Integration
    • Rich Status
    • Claude Code Hook Integration
    • Zero Coupling Design
  • Pane Actions
    • Why
    • Architecture
    • CLI
    • Runtime timing
    • Status integration
    • Extending

API Reference

  • scitex_agent_container API Reference
    • AgentConfig
      • AgentConfig.name
      • AgentConfig.runtime
      • AgentConfig.model
      • AgentConfig.workdir
      • AgentConfig.python_venv
      • AgentConfig.env
      • AgentConfig.env_files
      • AgentConfig.screen_name
      • AgentConfig.labels
      • AgentConfig.container
      • AgentConfig.claude
      • AgentConfig.health
      • AgentConfig.watchdog
      • AgentConfig.restart
      • AgentConfig.hooks
      • AgentConfig.listen
      • AgentConfig.extensions
      • AgentConfig.telegram
      • AgentConfig.remote
      • AgentConfig.skills
      • AgentConfig.context_management
      • AgentConfig.startup_commands
      • AgentConfig.startup
      • AgentConfig.mcp_servers
      • AgentConfig.multiplexer
      • AgentConfig.hosts_spec
      • AgentConfig.slurm
      • AgentConfig.scheduling
      • AgentConfig.orochi
      • AgentConfig.config_path
      • AgentConfig.expanded_workdir
      • AgentConfig.__init__()
    • load_config()
    • validate_config()
    • agent_start()
    • agent_stop()
    • agent_restart()
    • agent_status()
    • agent_logs()
    • Registry
      • Registry.__init__()
      • Registry.add()
      • Registry.remove()
      • Registry.get()
      • Registry.list_all()
      • Registry.exists()
      • Registry.cleanup_stale()
    • Config
      • AgentConfig
        • AgentConfig.name
        • AgentConfig.runtime
        • AgentConfig.model
        • AgentConfig.workdir
        • AgentConfig.python_venv
        • AgentConfig.env
        • AgentConfig.env_files
        • AgentConfig.screen_name
        • AgentConfig.labels
        • AgentConfig.container
        • AgentConfig.claude
        • AgentConfig.health
        • AgentConfig.watchdog
        • AgentConfig.restart
        • AgentConfig.hooks
        • AgentConfig.listen
        • AgentConfig.extensions
        • AgentConfig.telegram
        • AgentConfig.remote
        • AgentConfig.skills
        • AgentConfig.context_management
        • AgentConfig.startup_commands
        • AgentConfig.startup
        • AgentConfig.mcp_servers
        • AgentConfig.multiplexer
        • AgentConfig.hosts_spec
        • AgentConfig.slurm
        • AgentConfig.scheduling
        • AgentConfig.orochi
        • AgentConfig.config_path
        • AgentConfig.expanded_workdir
        • AgentConfig.__init__()
      • ClaudeSpec
        • ClaudeSpec.channels
        • ClaudeSpec.flags
        • ClaudeSpec.session
        • ClaudeSpec.continue_max_age_minutes
        • ClaudeSpec.resume_id
        • ClaudeSpec.auto_accept
        • ClaudeSpec.__init__()
      • ContainerSpec
        • ContainerSpec.runtime
        • ContainerSpec.image
        • ContainerSpec.volumes
        • ContainerSpec.network
        • ContainerSpec.mount_host_claude
        • ContainerSpec.__init__()
      • ContextManagementConfig
        • ContextManagementConfig.trigger_at_percent
        • ContextManagementConfig.strategy
        • ContextManagementConfig.warn_before_n_checks
        • ContextManagementConfig.check_interval_seconds
        • ContextManagementConfig.state_file
        • ContextManagementConfig.enabled
        • ContextManagementConfig.__init__()
      • HealthSpec
        • HealthSpec.enabled
        • HealthSpec.interval
        • HealthSpec.timeout
        • HealthSpec.method
        • HealthSpec.__init__()
      • HookSpec
        • HookSpec.pre_start
        • HookSpec.post_start
        • HookSpec.pre_stop
        • HookSpec.post_stop
        • HookSpec.on_compact
        • HookSpec.on_restart
        • HookSpec.on_diff
        • HookSpec.counts()
        • HookSpec.__init__()
      • HostsSpec
        • HostsSpec.host
        • HostsSpec.hosts
        • HostsSpec.__init__()
      • ListenPort
        • ListenPort.port
        • ListenPort.proto
        • ListenPort.path
        • ListenPort.name
        • ListenPort.owner
        • ListenPort.__init__()
      • OrochiSpec
        • OrochiSpec.enabled
        • OrochiSpec.hosts
        • OrochiSpec.port
        • OrochiSpec.token_env
        • OrochiSpec.channels
        • OrochiSpec.heartbeat_interval
        • OrochiSpec.__init__()
      • ReadyPattern
        • ReadyPattern.regex
        • ReadyPattern.__init__()
      • RemoteSpec
        • RemoteSpec.hops
        • RemoteSpec.host
        • RemoteSpec.user
        • RemoteSpec.key
        • RemoteSpec.port
        • RemoteSpec.timeout
        • RemoteSpec.login_shell
        • RemoteSpec.no_preflight
        • RemoteSpec.is_remote
        • RemoteSpec.__init__()
      • RestartSpec
        • RestartSpec.policy
        • RestartSpec.max_retries
        • RestartSpec.backoff_initial
        • RestartSpec.backoff_max
        • RestartSpec.backoff_multiplier
        • RestartSpec.__init__()
      • SchedulingSpec
        • SchedulingSpec.mode
        • SchedulingSpec.preferred_host
        • SchedulingSpec.fallback_hosts
        • SchedulingSpec.__init__()
      • SkillsSpec
        • SkillsSpec.required
        • SkillsSpec.available
        • SkillsSpec.injection_mode
        • SkillsSpec.match_by
        • SkillsSpec.match_style
        • SkillsSpec.__init__()
      • SlurmHeartbeatSpec
        • SlurmHeartbeatSpec.command
        • SlurmHeartbeatSpec.interval_s
        • SlurmHeartbeatSpec.log_file
        • SlurmHeartbeatSpec.__init__()
      • SlurmHooks
        • SlurmHooks.pre_submit
        • SlurmHooks.pre_agent
        • SlurmHooks.walltime_signal
        • SlurmHooks.post_agent
        • SlurmHooks.attach
        • SlurmHooks.__init__()
      • SlurmSpec
        • SlurmSpec.partition
        • SlurmSpec.time_limit
        • SlurmSpec.cpus_per_task
        • SlurmSpec.mem
        • SlurmSpec.nodes
        • SlurmSpec.ntasks
        • SlurmSpec.gres
        • SlurmSpec.job_name
        • SlurmSpec.signal
        • SlurmSpec.auto_resubmit
        • SlurmSpec.hold
        • SlurmSpec.logs_dir
        • SlurmSpec.hooks
        • SlurmSpec.heartbeat
        • SlurmSpec.extra_directives
        • SlurmSpec.reservation
        • SlurmSpec.__init__()
      • StartupCommand
        • StartupCommand.delay
        • StartupCommand.command
        • StartupCommand.__init__()
      • StartupSpec
        • StartupSpec.ready_patterns
        • StartupSpec.ready_idle_ticks
        • StartupSpec.ready_poll_interval_seconds
        • StartupSpec.ready_timeout_seconds
        • StartupSpec.on_timeout
        • StartupSpec.commands
        • StartupSpec.__init__()
      • TelegramSpec
        • TelegramSpec.bot_token_env
        • TelegramSpec.allowed_users
        • TelegramSpec.auto_connect
        • TelegramSpec.greeting
        • TelegramSpec.__init__()
      • WatchdogSpec
        • WatchdogSpec.enabled
        • WatchdogSpec.interval
        • WatchdogSpec.resp_y_n
        • WatchdogSpec.resp_y_y_n
        • WatchdogSpec.resp_waiting
        • WatchdogSpec.__init__()
      • compose_effective_name()
      • load_config()
      • resolve_config()
      • resolve_hostname()
      • substitute_hostnames()
      • validate_config()
      • validate_contributor_spec()
      • validate_contributor_spec_raw()
    • Lifecycle
      • _get_runtime()
      • _fallback_workdir()
      • _fire_forget_hook()
      • _run_hooks()
      • agent_start()
      • agent_stop()
      • agent_stop_all()
      • agent_restart()
      • agent_status()
      • agent_logs()
    • Registry
      • Registry
        • Registry.__init__()
        • Registry.add()
        • Registry.remove()
        • Registry.get()
        • Registry.list_all()
        • Registry.exists()
        • Registry.cleanup_stale()
    • Observability
      • detect_multiplexer()
      • _encode_claude_project()
      • _parse_skills()
      • parse_subagent_count_from_pane_text()
      • _capture_pane()
      • _classify_pane_state()
      • _config_candidates()
      • _parse_mcp_servers()
      • _read_sdk_session_state()
      • collect_rich()
      • _collect_action_summary_fields()
      • Design rules
      • _preview_tool_input()
      • append_event()
      • read_recent()
      • _compute_open_agent_calls()
      • summarize()
      • register_sidecar()
      • cache_dir()
      • _snapshot_lock()
      • _probe_screen_count()
      • _probe_claude_pid()
      • _probe_nproc()
      • gather_snapshot()
      • compute_diff_fields()
      • take_snapshot()
      • read_latest()
      • snapshot_tick()
    • Pane Actions
      • Why a base class
      • Subclass contract
      • Outcomes
      • ActionOutcome
        • ActionOutcome.SUCCESS
        • ActionOutcome.PRECONDITION_FAIL
        • ActionOutcome.SEND_ERROR
        • ActionOutcome.COMPLETION_TIMEOUT
        • ActionOutcome.SKIPPED_BY_POLICY
      • ActionContext
        • ActionContext.agent
        • ActionContext.session
        • ActionContext.mux
        • ActionContext.capture_fn
        • ActionContext.context_pct_fn
        • ActionContext.extras
        • ActionContext.__init__()
      • ActionAttempt
        • ActionAttempt.agent
        • ActionAttempt.action
        • ActionAttempt.outcome
        • ActionAttempt.elapsed_s
        • ActionAttempt.started_at
        • ActionAttempt.pane_before
        • ActionAttempt.pane_after
        • ActionAttempt.extras
        • ActionAttempt.as_store_record()
        • ActionAttempt.__init__()
      • PaneAction
        • PaneAction.name
        • PaneAction.snapshot()
        • PaneAction.precheck()
        • PaneAction.send()
        • PaneAction.is_complete()
        • PaneAction.before_send()
        • PaneAction.extras_at_end()
      • run_action()
      • Scope
      • Design rules (follows event_log.py conventions)
      • _safe_float()
      • _get_conn()
      • _truncate_snapshot()
      • append_attempt()
      • _parse_since()
      • query()
      • stats()
      • summarize()
      • purge_old()
      • _all_rows()
      • Composition
      • Outcome interpretation (via ActionOutcome)
      • NonceProbeAction
        • NonceProbeAction.name
        • NonceProbeAction.__init__()
        • NonceProbeAction.snapshot()
        • NonceProbeAction.precheck()
        • NonceProbeAction.before_send()
        • NonceProbeAction.send()
        • NonceProbeAction.is_complete()
      • Why a separate completion signal matters
      • Outcome interpretation
      • CompactAction
        • CompactAction.name
        • CompactAction.__init__()
        • CompactAction.snapshot()
        • CompactAction.precheck()
        • CompactAction.send()
        • CompactAction.is_complete()
      • _coerce_float()
    • Runtimes / Multiplexer
      • MultiplexerProtocol
        • MultiplexerProtocol.exists()
        • MultiplexerProtocol.start()
        • MultiplexerProtocol.stop()
        • MultiplexerProtocol.capture_content()
        • MultiplexerProtocol.capture_logs()
        • MultiplexerProtocol.send_keys()
        • MultiplexerProtocol.send_text_and_submit()
        • MultiplexerProtocol.attach()
        • MultiplexerProtocol.__init__()
      • get_multiplexer()
      • PromptHandler
        • PromptHandler.name
        • PromptHandler.detect
        • PromptHandler.keys
        • PromptHandler.priority
        • PromptHandler.__init__()
      • _detect_bypass_permissions()
      • _detect_dev_channels()
      • _detect_thinking_effort()
      • _detect_skip_permissions_yn()
      • _detect_mcp_json_edit()
      • _detect_press_enter_continue()
      • _detect_file_trust()
      • _detect_file_trust_radio()
      • _detect_external_imports()
      • _detect_login_method()
      • _detect_theme_selection()
      • _detect_compose_pending_unsent()
      • _detect_done()
      • register_prompt()
      • detect_and_respond()
      • is_ready()
scitex-agent-container
  • Search

© Copyright 2026, Yusuke Watanabe.

Built with Sphinx using a theme provided by Read the Docs.