Skip to content

overlane view run

Run a saved view and print its groups

Updated View as MarkdownOpen in ChatGPTOpen in Claude

Applies the view’s filter, sort and grouping to the project’s issues. The order is stable: the same data always gives the same output.

Usage

overlane view run view-id

Arguments

Argument Required Description
view-id yes The saved view ID

Examples

overlane view run viw_ab12cd34ef56gh78

Behavior

  • Effect: read (changes nothing).
  • Needs credentials: yes. Uses the network: yes.
  • Supports --dry-run: no. Accepts --force: no.
  • Machine-readable description: overlane schema view run.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 128,
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
      "description": "tenant identifier"
    },
    "viewId": {
      "anyOf": [
        {
          "type": "string",
          "pattern": "^viw_[A-Za-z0-9]{8,32}$",
          "description": "saved view identifier"
        },
        {
          "type": "null"
        }
      ]
    },
    "total": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "issues": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "tenantId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128,
                  "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
                  "description": "tenant identifier"
                },
                "projectId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 128,
                  "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
                  "description": "project identifier"
                },
                "createdAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
                },
                "updatedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
                },
                "archivedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
                },
                "deletedAt": {
                  "type": "string",
                  "format": "date-time",
                  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
                },
                "issueId": {
                  "type": "string",
                  "pattern": "^iss_[A-Za-z0-9]{8,32}$",
                  "description": "issue identifier"
                },
                "number": {
                  "type": "integer",
                  "exclusiveMinimum": 0,
                  "maximum": 9007199254740991
                },
                "title": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 300
                },
                "description": {
                  "type": "string",
                  "maxLength": 20000
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "backlog",
                    "todo",
                    "in_progress",
                    "in_review",
                    "done",
                    "cancelled"
                  ]
                },
                "priority": {
                  "type": "string",
                  "enum": [
                    "P0",
                    "P1",
                    "P2",
                    "P3"
                  ]
                },
                "rank": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": -9007199254740991,
                      "maximum": 9007199254740991
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "assignee": {
                  "anyOf": [
                    {
                      "oneOf": [
                        {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "const": "human"
                            },
                            "userId": {
                              "type": "string",
                              "minLength": 1,
                              "maxLength": 128
                            }
                          },
                          "required": [
                            "type",
                            "userId"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "const": "agent"
                            },
                            "executor": {
                              "type": "string",
                              "enum": [
                                "claude-code",
                                "codex"
                              ]
                            }
                          },
                          "required": [
                            "type",
                            "executor"
                          ],
                          "additionalProperties": false
                        },
                        {
                          "type": "object",
                          "properties": {
                            "type": {
                              "type": "string",
                              "const": "bot"
                            },
                            "botId": {
                              "type": "string",
                              "pattern": "^bot_[A-Za-z0-9]{8,32}$"
                            }
                          },
                          "required": [
                            "type",
                            "botId"
                          ],
                          "additionalProperties": false
                        }
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "assignedBy": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "type": {
                          "type": "string",
                          "enum": [
                            "human",
                            "agent",
                            "bot",
                            "sync",
                            "import",
                            "system"
                          ]
                        },
                        "id": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200
                        }
                      },
                      "required": [
                        "type",
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "externalAssignee": {
                  "anyOf": [
                    {
                      "type": "string",
                      "maxLength": 200
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "labelIds": {
                  "maxItems": 50,
                  "type": "array",
                  "items": {
                    "type": "string",
                    "pattern": "^lbl_[A-Za-z0-9]{8,32}$",
                    "description": "label identifier"
                  }
                },
                "workProjectId": {
                  "anyOf": [
                    {
                      "type": "string",
                      "pattern": "^wpr_[A-Za-z0-9]{8,32}$",
                      "description": "work project identifier"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "cycleId": {
                  "anyOf": [
                    {
                      "type": "string",
                      "pattern": "^cyc_[A-Za-z0-9]{8,32}$",
                      "description": "cycle identifier"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "estimate": {
                  "anyOf": [
                    {
                      "type": "integer",
                      "minimum": 0,
                      "maximum": 1000
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "links": {
                  "type": "object",
                  "properties": {
                    "tasks": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "taskId": {
                            "type": "string",
                            "minLength": 1,
                            "maxLength": 128,
                            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
                            "description": "task identifier"
                          },
                          "state": {
                            "type": "string",
                            "enum": [
                              "active",
                              "closed"
                            ]
                          },
                          "linkedAt": {
                            "type": "string",
                            "format": "date-time",
                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
                          },
                          "assignedBy": {
                            "type": "object",
                            "properties": {
                              "type": {
                                "type": "string",
                                "enum": [
                                  "human",
                                  "agent",
                                  "bot",
                                  "sync",
                                  "import",
                                  "system"
                                ]
                              },
                              "id": {
                                "type": "string",
                                "minLength": 1,
                                "maxLength": 200
                              }
                            },
                            "required": [
                              "type",
                              "id"
                            ],
                            "additionalProperties": false
                          }
                        },
                        "required": [
                          "taskId",
                          "state",
                          "linkedAt",
                          "assignedBy"
                        ],
                        "additionalProperties": false
                      }
                    },
                    "pullRequests": {
                      "maxItems": 100,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "pattern": "^[\\w.-]+\\/[\\w.-]+#\\d+$"
                      }
                    },
                    "runs": {
                      "maxItems": 100,
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 128
                      }
                    }
                  },
                  "required": [
                    "tasks",
                    "pullRequests",
                    "runs"
                  ],
                  "additionalProperties": false
                },
                "external": {
                  "anyOf": [
                    {
                      "type": "object",
                      "properties": {
                        "source": {
                          "type": "string",
                          "enum": [
                            "overlane",
                            "github",
                            "linear",
                            "jira",
                            "github_projects",
                            "tasks_md"
                          ]
                        },
                        "id": {
                          "type": "string",
                          "minLength": 1,
                          "maxLength": 200
                        },
                        "url": {
                          "type": "string",
                          "maxLength": 500,
                          "format": "uri"
                        }
                      },
                      "required": [
                        "source",
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "createdBy": {
                  "type": "object",
                  "properties": {
                    "type": {
                      "type": "string",
                      "enum": [
                        "human",
                        "agent",
                        "bot",
                        "sync",
                        "import",
                        "system"
                      ]
                    },
                    "id": {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 200
                    }
                  },
                  "required": [
                    "type",
                    "id"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "tenantId",
                "projectId",
                "createdAt",
                "updatedAt",
                "issueId",
                "number",
                "title",
                "description",
                "status",
                "priority",
                "rank",
                "assignee",
                "assignedBy",
                "externalAssignee",
                "labelIds",
                "workProjectId",
                "cycleId",
                "estimate",
                "links",
                "external",
                "createdBy"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "key",
          "issues"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "viewId",
    "total",
    "groups"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close

Overlane Agent

Ask about the docs. Answers are quoted from the pages, with links. This panel cannot change anything.

    Questions are answered in your browser from the docs index. Nothing you type here is stored or sent anywhere.