startCustomCommandRun

Mutation

mutation StartCustomCommandRun($input: StartCustomCommandRunInput!) {
  startCustomCommandRun(input: $input) {
    id
    displayNumber
    commandId
    command {
      id
      name
      description
      script
      targetKind
      targetAgentId
    }
    origin
    status
  }
}

Variables

{
  "input": {
    "script": "string"
  }
}

Response

{
  "data": {
    "startCustomCommandRun": {
      "id": "id",
      "displayNumber": 1,
      "commandId": "id",
      "command": {
        "id": "id",
        "name": "string",
        "description": "string",
        "script": "string",
        "targetKind": "ANY_AGENT_HOME",
        "targetAgentId": "id"
      },
      "origin": "MANUAL",
      "status": "QUEUED"
    }
  }
}

MUTATION

startCustomCommandRun(input: StartCustomCommandRunInput!): CommandRun!

Arguments

input

StartCustomCommandRunInput!

required

Values for the requested operation.

Returns

CommandRun!

ID!

Stable identifier for this command run.

displayNumber

Int!

The display number associated with this command run.

commandId

Identifier of the related command. May be null when unavailable or not applicable.

command

CommandDefinition

The command associated with this command run. May be null when unavailable or not applicable.

origin

CommandRunOrigin!

The origin associated with this command run.

status

CommandRunStatus!

Current status of this command run.

snapshotName

String!

The snapshot name associated with this command run.

snapshotDescription

String!

The snapshot description associated with this command run.

snapshotScript

String!

The snapshot script associated with this command run.

snapshotTargetKind

CommandTargetKind!

The snapshot target kind associated with this command run.

snapshotRestartPolicy

CommandRestartPolicy!

The snapshot restart policy associated with this command run.

snapshotRestartLimit

Int

The snapshot restart limit associated with this command run. May be null when unavailable or not applicable.

snapshotConcurrency

CommandConcurrency!

The snapshot concurrency associated with this command run.

snapshotBlocksGitOperations

Boolean!

Whether this run blocks Git and worktree operations on its codebase.

snapshotNotificationsEnabled

Boolean!

Whether the snapshot notifications enabled condition is true for this command run.

snapshot

JSON!

The snapshot associated with this command run.

agentId

Identifier of the related agent. May be null when unavailable or not applicable.

agent

Agent

The agent associated with this command run. May be null when unavailable or not applicable.

worktreeId

Identifier of the related worktree. May be null when unavailable or not applicable.

worktree

Worktree

The worktree associated with this command run. May be null when unavailable or not applicable.

agentName

String!

The agent name associated with this command run.

agentHostname

String!

The agent hostname associated with this command run.

worktreePath

String

Filesystem path associated with this command run. May be null when unavailable or not applicable.

worktreeBranch

String

Git branch associated with this command run. May be null when unavailable or not applicable.

restartCount

Int!

Number of restarts.

stopRequested

Boolean!

Whether the stop requested condition is true for this command run.

nextRestartAt

String

ISO 8601 timestamp when this command run next restart. May be null when unavailable or not applicable.

predecessorRunId

Identifier of the related predecessor run. May be null when unavailable or not applicable.

predecessor

CommandRun

The predecessor associated with this command run. May be null when unavailable or not applicable.

successor

CommandRun

The successor associated with this command run. May be null when unavailable or not applicable.

error

String

Error message when this command run did not complete successfully. May be null when unavailable or not applicable.

exitCode

Int

The exit code associated with this command run. May be null when unavailable or not applicable.

signal

String

The signal associated with this command run. May be null when unavailable or not applicable.

attempts

[CommandRunAttempt!]!

Attempts associated with this command run.

queue

CommandRunQueue!

Explains why this command run has not started, and lists the runs competing for its target.

queuedAt

String!

ISO 8601 timestamp when this command run was queued.

startedAt

String

ISO 8601 timestamp when this command run started. May be null when unavailable or not applicable.

finishedAt

String

ISO 8601 timestamp when this command run finished. May be null when unavailable or not applicable.

archivedAt

String

ISO 8601 timestamp when this command run was archived. May be null when unavailable or not applicable.

createdAt

String!

ISO 8601 timestamp when this command run was created.

updatedAt

String!

ISO 8601 timestamp when this command run was last updated.

Mutation

mutation StartCustomCommandRun($input: StartCustomCommandRunInput!) {
  startCustomCommandRun(input: $input) {
    id
    displayNumber
    commandId
    command {
      id
      name
      description
      script
      targetKind
      targetAgentId
    }
    origin
    status
  }
}

Variables

{
  "input": {
    "script": "string"
  }
}

Response

{
  "data": {
    "startCustomCommandRun": {
      "id": "id",
      "displayNumber": 1,
      "commandId": "id",
      "command": {
        "id": "id",
        "name": "string",
        "description": "string",
        "script": "string",
        "targetKind": "ANY_AGENT_HOME",
        "targetAgentId": "id"
      },
      "origin": "MANUAL",
      "status": "QUEUED"
    }
  }
}

Overview

Queries

Mutations

Types

Arguments

Returns