overlane usage policy show

Show how the project and you spend subscription usage, the cap that applies and which clients can start now

Prints the project’s usage policy (order, pace, cap), your own caps, and the cap that applies: the lowest of the project cap, your cap and 100 minus the share you keep free. For each client it says whether it can take the next iteration now and, if not, why.

Usage

overlane usage policy show

Examples

overlane usage policy show

Behavior

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

Result

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

{
  "type": "object",
  "properties": {
    "project": {
      "type": "object",
      "properties": {
        "order": {
          "default": "sequential",
          "type": "string",
          "enum": [
            "sequential",
            "round_robin",
            "parallel"
          ]
        },
        "maxParallel": {
          "default": 1,
          "type": "integer",
          "minimum": 1,
          "maximum": 9007199254740991
        },
        "pace": {
          "default": "asap",
          "type": "string",
          "enum": [
            "asap",
            "steady"
          ]
        },
        "capPercent": {
          "default": 85,
          "type": "integer",
          "minimum": 1,
          "maximum": 100
        },
        "reservePercent": {
          "default": 0,
          "type": "integer",
          "minimum": 0,
          "maximum": 99
        },
        "iterationsPerWindow": {
          "type": "integer",
          "minimum": 1,
          "maximum": 9007199254740991
        }
      },
      "required": [
        "order",
        "maxParallel",
        "pace",
        "capPercent",
        "reservePercent"
      ],
      "additionalProperties": false
    },
    "user": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "order": {
              "default": "sequential",
              "type": "string",
              "enum": [
                "sequential",
                "round_robin",
                "parallel"
              ]
            },
            "maxParallel": {
              "default": 1,
              "type": "integer",
              "minimum": 1,
              "maximum": 9007199254740991
            },
            "pace": {
              "default": "asap",
              "type": "string",
              "enum": [
                "asap",
                "steady"
              ]
            },
            "capPercent": {
              "default": 85,
              "type": "integer",
              "minimum": 1,
              "maximum": 100
            },
            "reservePercent": {
              "default": 0,
              "type": "integer",
              "minimum": 0,
              "maximum": 99
            },
            "iterationsPerWindow": {
              "type": "integer",
              "minimum": 1,
              "maximum": 9007199254740991
            }
          },
          "required": [
            "order",
            "maxParallel",
            "pace",
            "capPercent",
            "reservePercent"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ]
    },
    "shareUsageEvents": {
      "type": "boolean"
    },
    "effectiveCap": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "executors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "executor": {
            "type": "string",
            "enum": [
              "claude-code",
              "codex",
              "gemini-cli",
              "cursor"
            ]
          },
          "eligible": {
            "type": "boolean"
          },
          "cause": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "policy_pause",
                  "not_allowed",
                  "paused_this_task",
                  "signed_out",
                  "model_unavailable",
                  "cooling",
                  "over_cap",
                  "pacing",
                  "not_listed"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "reason": {
            "type": [
              "string",
              "null"
            ]
          },
          "waitUntil": {
            "anyOf": [
              {
                "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))$"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "executor",
          "eligible",
          "cause",
          "reason",
          "waitUntil"
        ],
        "additionalProperties": false
      }
    },
    "at": {
      "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))$"
    }
  },
  "required": [
    "project",
    "user",
    "shareUsageEvents",
    "effectiveCap",
    "executors",
    "at"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.